2004-10-11 Shane Landrum <epicene@pobox.com>
* en/Gdk/Pixbuf.xml * en/Gdk/PixbufAlphaMode.xml * en/Gdk/PixbufAniAnim.xml * en/Gdk/PixbufAniAnimIter.xml * en/Gdk/PixbufDestroyNotify.xml * en/Gdk/PixbufError.xml * en/Gdk/PixbufFormat.xml * en/Gdk/PixbufFrame.xml: Miscellaneous docs for pixbuf classes. svn path=/trunk/gtk-sharp/; revision=34857
This commit is contained in:
parent
881f9655f4
commit
7908ad667b
9 changed files with 80 additions and 65 deletions
|
@ -1,3 +1,14 @@
|
|||
2004-10-11 Shane Landrum <epicene@pobox.com>
|
||||
|
||||
* en/Gdk/Pixbuf.xml
|
||||
* en/Gdk/PixbufAlphaMode.xml
|
||||
* en/Gdk/PixbufAniAnim.xml
|
||||
* en/Gdk/PixbufAniAnimIter.xml
|
||||
* en/Gdk/PixbufDestroyNotify.xml
|
||||
* en/Gdk/PixbufError.xml
|
||||
* en/Gdk/PixbufFormat.xml
|
||||
* en/Gdk/PixbufFrame.xml: Miscellaneous docs for pixbuf classes.
|
||||
|
||||
2004-09-25 Shane Landrum <epicene@pobox.com>
|
||||
|
||||
* en/Gdk/Drawable.xml
|
||||
|
|
|
@ -1130,9 +1130,9 @@
|
|||
<Parameter Name="copy_pixels" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Constructor.</summary>
|
||||
<param name="data">A <see cref="T:System.Byte []"/></param>
|
||||
<param name="copy_pixels">A <see cref="T:System.Boolean"/></param>
|
||||
<param name="copy_pixels">A <see cref="T:System.Boolean"/>, whether to copy raw pixel data; run-length encoded pixel data is always copied.</param>
|
||||
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
|
@ -1194,10 +1194,10 @@
|
|||
<Parameter Name="resource" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Loads a pixbuf from a resource string.</summary>
|
||||
<param name="resource">a <see cref="T:System.String" /></param>
|
||||
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
||||
<remarks/>
|
||||
<remarks>TODO: Clarify.</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
@ -1327,8 +1327,8 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>a <see cref="T:System.IntPtr" /></returns>
|
||||
<summary>The pixels contained by this Pixbuf object.</summary>
|
||||
<returns>a <see cref="T:System.IntPtr" />, pointer to the underlying C data</returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
@ -1345,7 +1345,7 @@
|
|||
<Parameter Name="option_values" Type="System.String[]" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Saves pixbuf to a file.</summary>
|
||||
<param name="filename">Name of the file where the image will be saved</param>
|
||||
<param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param>
|
||||
<param name="option_keys">Options that are passed to the save module.</param>
|
||||
|
@ -1365,11 +1365,15 @@
|
|||
<Parameter Name="type" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="filename">a <see cref="T:System.String" /></param>
|
||||
<param name="type">a <see cref="T:System.String" /></param>
|
||||
<summary>Saves pixbuf to a file.</summary>
|
||||
<param name="filename">a <see cref="T:System.String" />, name of the file to save</param>
|
||||
<param name="type">a <see cref="T:System.String" />, file format to save in ("jpeg" and "png" are supported).</param>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks/>
|
||||
<remarks>The Gtk+ version of this call supports a text string of
|
||||
arguments, which Gtk# currently does not include. (TODO: explain
|
||||
the difference between Save and Savev, in light of this API
|
||||
difference.)
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RenderThresholdAlpha">
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Do not use.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -50,7 +50,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Do not use.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
|
|
@ -34,7 +34,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Do not use.</summary>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
|
@ -34,7 +34,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Do not use.</summary>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
|
|
|
@ -7,8 +7,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>Delegate class for code to be run when a <see cref="T:Gdk.Pixbuf"/> object is destroyed.</summary>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Delegate</BaseTypeName>
|
||||
|
@ -29,4 +29,4 @@
|
|||
<ReturnValue>
|
||||
<ReturnType>System.Void</ReturnType>
|
||||
</ReturnValue>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
@ -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>Possible errors that can be thrown by a <see cref="T:Gdk.Pixbuf"/>.</summary>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Enum</BaseTypeName>
|
||||
|
@ -37,7 +37,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The image file is corrupt.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -50,7 +50,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>There is insufficient memory to hold this pixbuf data.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -63,7 +63,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>An invalid option was specified.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -76,7 +76,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The given file type is not allowed.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -89,7 +89,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The given operation is not supported.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -102,7 +102,7 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The operation failed.</summary>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
|
@ -121,4 +121,4 @@
|
|||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
@ -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 possible format for a <see cref="T:Gdk.Pixbuf"/>.</summary>
|
||||
<remarks>Mostly for internal use.</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.ValueType</BaseTypeName>
|
||||
|
@ -26,9 +26,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>A description of the format.</summary>
|
||||
<returns>a <see cref="T:System.String" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="MimeTypes">
|
||||
|
@ -38,9 +38,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The MIME types supported by the format.</summary>
|
||||
<returns>a <see cref="T:System.String" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Extensions">
|
||||
|
@ -50,9 +50,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The filename extensions typically used for files in the given format.</summary>
|
||||
<returns>a <see cref="T:System.String" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Name">
|
||||
|
@ -62,9 +62,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>The name of the format.</summary>
|
||||
<returns>a <see cref="T:System.String" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IsWritable">
|
||||
|
@ -75,9 +75,9 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<summary>Whether pixbufs can be saved in the given format.</summary>
|
||||
<returns>a <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
@ -88,11 +88,11 @@
|
|||
<Parameter Name="raw" Type="System.IntPtr" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="raw">a <see cref="T:System.IntPtr" /></param>
|
||||
<summary>Basic constructor.</summary>
|
||||
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C data structure.</param>
|
||||
<returns>a <see cref="T:Gdk.PixbufFormat" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
|
@ -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>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.ValueType</BaseTypeName>
|
||||
|
@ -28,7 +28,7 @@
|
|||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="New">
|
||||
|
@ -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 'Gdk.PixbufFrame'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<param name="raw">A <see cref="T:IntPtr"/></param>
|
||||
<returns>A <see cref="T:Gdk.PixbufFrame"/></returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="revert">
|
||||
|
@ -57,9 +57,9 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
|
||||
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="composited">
|
||||
|
@ -72,9 +72,9 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
|
||||
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="pixbuf">
|
||||
|
@ -87,9 +87,9 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
|
||||
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
|
||||
<returns>A <see cref="T:Gdk.Pixbuf"/></returns>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="XOffset">
|
||||
|
@ -102,7 +102,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="YOffset">
|
||||
|
@ -115,7 +115,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="DelayTime">
|
||||
|
@ -128,7 +128,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Elapsed">
|
||||
|
@ -141,7 +141,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Action">
|
||||
|
@ -154,7 +154,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="NeedRecomposite">
|
||||
|
@ -167,7 +167,7 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="BgTransparent">
|
||||
|
@ -180,8 +180,8 @@
|
|||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<remarks/>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
</Type>
|
||||
</Type>
|
||||
|
|
Loading…
Reference in a new issue