svn path=/trunk/gtk-sharp/; revision=40505
This commit is contained in:
Miguel de Icaza 2005-02-11 22:59:00 +00:00
parent 2eaa69000c
commit b0fe1620ea
7 changed files with 98 additions and 106 deletions

View File

@ -10,8 +10,14 @@
</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 Structure AlphaGamma supports a specific value of gama.</summary>
<remarks>The composition with an AlphaGamma parameter is equivalent to applying a gama transformation to source images, with a alpha composition done in linear intensity space, and then applying the inverse gama tranformation, to place it back on the gamma-adjusted intensity space.
<block subset="none" type="note">
<para>
This is only true when its correctly implemented, wich isn't generally the case in libart implementation.
</para>
</block></remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -58,10 +64,10 @@
<Parameter Name="gamma" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new AlphaGamma with a particular gamma value.</summary>
<param name="gamma">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:Art.AlphaGamma" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Free">
@ -72,8 +78,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees any resouces that are held by this structure.</summary>
<remarks />
</Docs>
</Member>
</Members>

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>Support Structure for Bezier Paths</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -58,10 +58,10 @@
<Parameter Name="matrix" Type="System.Double[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="matrix">a <see cref="T:System.Double[]" /></param>
<returns>a <see cref="T:Art.Bpath" /></returns>
<remarks>To be added</remarks>
<summary>Apply an affine transform to the Bezier Path.</summary>
<param name="matrix">An Affine Transformation.</param>
<returns>A new Bezier Path that is the result of the current with the affien transformation applyed to it.</returns>
<remarks>Matrix has to be a six position array.</remarks>
</Docs>
</Member>
<Member MemberName="Code">

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>Allows the selection of the required filter level.</summary>
<remarks>Cubic filtering is missing because hyper is just as fast to implement and slightly better in quality.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -38,7 +38,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Nearest neighbor implementation. Fastest and lowest quality.</summary>
<remarks>
</remarks>
</Docs>
@ -52,7 +52,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Accurate simulation of the PostScript image operator without any interpolation. Each pixed is rendered as a small parallelogra, of solid color, with its edges implemented with antialiasing. It looks like Nearest on enlargement and Bilinear on reduction.</summary>
<remarks>
</remarks>
</Docs>
@ -66,7 +66,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Bilinear interpolation. On enlargement its equivalent to point-sampling the ideal bilinear-interpolated image. On reduction, its equivalent to laying down samll tiles and integrating over the coverage area.</summary>
<remarks>
</remarks>
</Docs>
@ -80,7 +80,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Slowest and highest quality reconstruction, derived from the hyperbolic filters in Wolberg's "Digital Image Warping". Hyperbolic-filter sampling the ideal hyperbolic-filter interpolated image (its designed to be idempotent for 1:1 pixel mapping).</summary>
<remarks>
</remarks>
</Docs>

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 structure encapsulates a buffer of pixels, that can be in several specific pixel buffer formats.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -56,9 +56,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a deep clone of the current instance.</summary>
<returns>A fresh deep copy of the current instance.</returns>
<remarks>Event the buffer that was given to create this buffer is copied, and its dealocation is then done by the new instance on its destruction, independently of who is responsible to free the curren buffer.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
@ -69,8 +69,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees any used resources.</summary>
<remarks>If the destroy delegate was given its invoked, otherwise if it wasn't created with NewConstRGBx it will free the memory held by the buffer.</remarks>
</Docs>
</Member>
<Member MemberName="FreeShallow">
@ -81,8 +81,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees just the resources held by the PixBuf ignoring the given buffer.</summary>
<remarks>Its deprecated.</remarks>
</Docs>
</Member>
<Member MemberName="NewConstRgb">
@ -98,13 +98,13 @@
<Parameter Name="rowstride" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGB PixBuf.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGB.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="NewConstRgba">
@ -120,13 +120,13 @@
<Parameter Name="rowstride" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGBA PixBuf.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGBA.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="NewRgb">
@ -142,13 +142,13 @@
<Parameter Name="rowstride" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGB PixBuf.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGB.</returns>
<remarks>On destruction, the created instance will free the memory used by given buffer in pixels.</remarks>
</Docs>
</Member>
<Member MemberName="NewRgbDnotify">
@ -166,15 +166,15 @@
<Parameter Name="dfunc" Type="Art.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="dfunc_data">a <see cref="T:System.IntPtr" /></param>
<param name="dfunc">a <see cref="T:Art.DestroyNotify" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGB PixBuf that invokes the given delegate on destruction.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<param name="dfunc_data">The data that will be given to dfunc on its invocation.</param>
<param name="dfunc">The delegate that is going to be invoked when the PixBuf gets destroyed.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGB that invokes a delegate on its destruction.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="NewRgba">
@ -190,13 +190,13 @@
<Parameter Name="rowstride" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGBA PixBuf.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGB.</returns>
<remarks>On destruction, the created instance will free the memory used by given buffer in pixels.</remarks>
</Docs>
</Member>
<Member MemberName="NewRgbaDnotify">
@ -214,15 +214,15 @@
<Parameter Name="dfunc" Type="Art.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixels">a <see cref="T:System.Byte&amp;" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="rowstride">a <see cref="T:System.Int32" /></param>
<param name="dfunc_data">a <see cref="T:System.IntPtr" /></param>
<param name="dfunc">a <see cref="T:Art.DestroyNotify" /></param>
<returns>a <see cref="T:Art.PixBuf" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new RGBA PixBuf that invokes the given delegate on destruction.</summary>
<param name="pixels">The buffer containing the actual pixel data.</param>
<param name="width">The width of the pixbuf.</param>
<param name="height">The height of the pixbuf.</param>
<param name="rowstride">The row stride of the pixbuf.</param>
<param name="dfunc_data">The data that will be given to dfunc on its invocation.</param>
<param name="dfunc">The delegate that is going to be invoked when the PixBuf gets destroyed.</param>
<returns>A newly created <see cref="T:Art.PixBuf" /> RGBA that invokes a delegate on its destruction.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Format">

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>This class manages, in a persist way, the configuration information of the application.</summary>
<remarks>The handling is done in a independent way of the selected locale.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -207,11 +207,11 @@
<Parameter Name="priv" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:System.String" /></param>
<summary>Flushes all the configuration data to disk, for a given file.</summary>
<param name="path">The path of the target file.</param>
<param name="priv">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>Returns <see cref="T:True" /> if its able to write to disk, otherwise its <see cref="T:False" />.</returns>
<remarks>Nothing is saved on disk till this method gets invoked, or Sync().</remarks>
</Docs>
</Member>
<Member MemberName="CleanSection_">
@ -258,8 +258,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Clears any cached information, including any information that has not been written to file.</summary>
<remarks>All non saved configuration data is lost.</remarks>
</Docs>
</Member>
<Member MemberName="CleanKey_">
@ -342,9 +342,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Flushes all the configuration data to disk.</summary>
<returns>Returns <see cref="T:True" /> if its able to write to disk, otherwise its <see cref="T:False" />.</returns>
<remarks>Nothing is saved on disk till this method gets invoked, or SyncFile_.</remarks>
</Docs>
</Member>
<Member MemberName="InitIterator_">
@ -471,11 +471,11 @@
<Parameter Name="priv" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="path">a <see cref="T:System.String" /></param>
<param name="def">a <see cref="T:System.Boolean&amp;" /></param>
<summary>Gets the value associated with the path as a <see cref="T:System.String" />, if its not present, the default value will be used.</summary>
<param name="path">The path to the required item.</param>
<param name="def">If the default value for the item is returned its set to a <see cref="T:True" /> otherwise its a <see cref="T:False" />.</param>
<param name="priv">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.String" /></returns>
<returns>Returns the value in the configuration path or the default value if its not present, as a <see cref="T:System.String" />. </returns>
<remarks>To be added</remarks>
</Docs>
</Member>

View File

@ -1512,7 +1512,7 @@ store = new TreeStore (typeof (int), typeof (string));
<returns>a <see cref="T:Gtk.TreeIter" /></returns>
<remarks>
<para>
If parent and is <see langword="null" />, then the row will be prepended to the toplevel.
If parent is <see langword="null" />, then the row will be prepended to the toplevel.
</para>
</remarks>
</Docs>
@ -1580,8 +1580,9 @@ store = new TreeStore (typeof (int), typeof (string));
<Docs>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.TreeStore" /></returns>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1146,7 +1146,7 @@ This property tells GTK# that the user interface for your application requires u
<param name="attrs">attributes</param>
<returns>The appended <see cref="T:Gtk.TreeViewColumn" /></returns>
<remarks>
<para>This function is used to append a new <see cref="T:Gtk.CellRenderer" /> subclass with specific attributes to the <see cref="T:Gtl.TreeView" />.</para>
<para>This function is used to append a new <see cref="T:Gtk.CellRenderer" /> subclass with specific attributes to the <see cref="T:Gtk.TreeView" />.</para>
<para>
The following code sample will append a new <see cref="T:Gtk.CellRendererText" /> to an existing <see cref="T:Gtk.TreeView" /> and use column 0 from the <see cref="T:Gtk.TreeStore" /> as the text to render.
</para>
@ -1156,21 +1156,6 @@ CellRendererText text = new CellRendererText ();
tree_view.AppendColumn ("title", text, "text", 0);
</code>
</example>
<para>This example illustrates how you can control the "editable" attribute of a column on a row-by-row basis.</para>
<example>
<code lang="C#">
TreeStore store = new TreeStore (typeof (string), typeof(bool));
/* add a column that will display the 'string' from the store */
/* note that we are binding the "text" value to column 0 of the store, and the "editable" value to the column 1 value of the store */
/* this enables per-row control over the editable flag, if desired */
tv.AppendColumn("My string", new CellRendererText(), "text", 0, "editable", 1);
/* add a couple of rows to the treeview */
store.AppendValues("You can edit this", true);
store.AppendValues("You can't edit this", false);
</code>
</example>
</remarks>
</Docs>
</Member>