diff --git a/doc/ChangeLog b/doc/ChangeLog index d53283d24..dc03f4af0 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2004-09-03 Mike Kestner <mkestner@ximian.com> + + * en/Gdk/Pixmap.cs : updates to sigs of FromXpm* methods. + * en/Gtk/Init.cs : fix Check and remove AbiCheck. + * en/Gtk/Invisible.cs : add ctor. + * en/Gtk/NodeStore.cs : add GType prop. + 2004-09-02 Mike Kestner <mkestner@ximian.com> * updater/* : rework of duncan's updater from monodoc that doesn't diff --git a/doc/en/Gdk/Pixmap.xml b/doc/en/Gdk/Pixmap.xml index 7c0ec69c1..ada49ed00 100644 --- a/doc/en/Gdk/Pixmap.xml +++ b/doc/en/Gdk/Pixmap.xml @@ -95,52 +95,6 @@ For example in the X backend, a native pixmap handle is an Xlib XID. </remarks> </Docs> </Member> - <Member MemberName="ColormapCreateFromXpmD"> - <MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpmD (Gdk.Drawable drawable, Gdk.Colormap colormap, Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>Gdk.Pixmap</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="drawable" Type="Gdk.Drawable" /> - <Parameter Name="colormap" Type="Gdk.Colormap" /> - <Parameter Name="mask" Type="Gdk.Bitmap" /> - <Parameter Name="transparent_color" Type="Gdk.Color" /> - <Parameter Name="data" Type="System.String" /> - </Parameters> - <Docs> - <summary>To be added</summary> - <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> - <param name="colormap">a <see cref="T:Gdk.Colormap" /></param> - <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> - <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> - <param name="data">a <see cref="T:System.String" /></param> - <returns>a <see cref="T:Gdk.Pixmap" /></returns> - <remarks>To be added</remarks> - </Docs> - </Member> - <Member MemberName="CreateFromXpm"> - <MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpm (Gdk.Drawable drawable, Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>Gdk.Pixmap</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="drawable" Type="Gdk.Drawable" /> - <Parameter Name="mask" Type="Gdk.Bitmap" /> - <Parameter Name="transparent_color" Type="Gdk.Color" /> - <Parameter Name="filename" Type="System.String" /> - </Parameters> - <Docs> - <summary>To be added</summary> - <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> - <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> - <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> - <param name="filename">a <see cref="T:System.String" /></param> - <returns>a <see cref="T:Gdk.Pixmap" /></returns> - <remarks>To be added</remarks> - </Docs> - </Member> <Member MemberName="LookupForDisplay"> <MemberSignature Language="C#" Value="public static Gdk.Pixmap LookupForDisplay (Gdk.Display display, uint anid);" /> <MemberType>Method</MemberType> @@ -180,52 +134,6 @@ For example in the X backend, a native pixmap handle is an Xlib XID. </para></remarks> </Docs> </Member> - <Member MemberName="ColormapCreateFromXpm"> - <MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpm (Gdk.Drawable drawable, Gdk.Colormap colormap, Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>Gdk.Pixmap</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="drawable" Type="Gdk.Drawable" /> - <Parameter Name="colormap" Type="Gdk.Colormap" /> - <Parameter Name="mask" Type="Gdk.Bitmap" /> - <Parameter Name="transparent_color" Type="Gdk.Color" /> - <Parameter Name="filename" Type="System.String" /> - </Parameters> - <Docs> - <summary>Create a pixmap from a XPM file.</summary> - <param name="drawable">a <see cref="T:Gdk.Drawable" />, used to determine default values for the new pixmap.</param> - <param name="colormap">The <see cref="T:Gdk.Colormap" /> that the new pixmap will be use. If omitted, the colormap for <paramref name="drawable" /> will be used.</param> - <param name="mask">a <see cref="T:Gdk.Bitmap" /> a pointer to a place to store a bitmap representing the transparency mask of the XPM file. Can be <see langword="null" />, in which case transparency will be ignored.</param> - <param name="transparent_color">The color to be used for the pixels that are transparent in the input file. Can be <see langword="null" />, in which case a default color will be used.</param> - <param name="filename">The filename</param> - <returns>a <see cref="T:Gdk.Pixmap" /></returns> - <remarks>Create a pixmap from a XPM file using a particular colormap.</remarks> - </Docs> - </Member> - <Member MemberName="CreateFromXpmD"> - <MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpmD (Gdk.Drawable drawable, Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>Gdk.Pixmap</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="drawable" Type="Gdk.Drawable" /> - <Parameter Name="mask" Type="Gdk.Bitmap" /> - <Parameter Name="transparent_color" Type="Gdk.Color" /> - <Parameter Name="data" Type="System.String" /> - </Parameters> - <Docs> - <summary>To be added</summary> - <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> - <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> - <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> - <param name="data">a <see cref="T:System.String" /></param> - <returns>a <see cref="T:Gdk.Pixmap" /></returns> - <remarks>To be added</remarks> - </Docs> - </Member> <Member MemberName="CreateFromData"> <MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromData (Gdk.Drawable drawable, string data, int width, int height, int depth, Gdk.Color fg, Gdk.Color bg);" /> <MemberType>Method</MemberType> @@ -320,5 +228,97 @@ For example in the X backend, a native pixmap handle is an Xlib XID. <remarks>Creates a new pixmap with a given size and depth.</remarks> </Docs> </Member> + <Member MemberName="CreateFromXpmD"> + <MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpmD (Gdk.Drawable drawable, out Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" /> + <MemberType>Method</MemberType> + <ReturnValue> + <ReturnType>Gdk.Pixmap</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="drawable" Type="Gdk.Drawable" /> + <Parameter Name="mask" Type="Gdk.Bitmap&" RefType="out" /> + <Parameter Name="transparent_color" Type="Gdk.Color" /> + <Parameter Name="data" Type="System.String" /> + </Parameters> + <Docs> + <summary>Create a pixmap from XPM data.</summary> + <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> + <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> + <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> + <param name="data">a <see cref="T:System.String" /></param> + <returns>a <see cref="T:Gdk.Pixmap" /></returns> + <remarks>To be added</remarks> + </Docs> + </Member> + <Member MemberName="ColormapCreateFromXpm"> + <MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpm (Gdk.Drawable drawable, Gdk.Colormap colormap, out Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" /> + <MemberType>Method</MemberType> + <ReturnValue> + <ReturnType>Gdk.Pixmap</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="drawable" Type="Gdk.Drawable" /> + <Parameter Name="colormap" Type="Gdk.Colormap" /> + <Parameter Name="mask" Type="Gdk.Bitmap&" RefType="out" /> + <Parameter Name="transparent_color" Type="Gdk.Color" /> + <Parameter Name="filename" Type="System.String" /> + </Parameters> + <Docs> + <summary>Create a pixmap from an XPM file using a specific colormap.</summary> + <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> + <param name="colormap">a <see cref="T:Gdk.Colormap" /></param> + <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> + <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> + <param name="filename">a <see cref="T:System.String" /></param> + <returns>a <see cref="T:Gdk.Pixmap" /></returns> + <remarks>To be added</remarks> + </Docs> + </Member> + <Member MemberName="CreateFromXpm"> + <MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpm (Gdk.Drawable drawable, out Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" /> + <MemberType>Method</MemberType> + <ReturnValue> + <ReturnType>Gdk.Pixmap</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="drawable" Type="Gdk.Drawable" /> + <Parameter Name="mask" Type="Gdk.Bitmap&" RefType="out" /> + <Parameter Name="transparent_color" Type="Gdk.Color" /> + <Parameter Name="filename" Type="System.String" /> + </Parameters> + <Docs> + <summary>Create a pixmap from an XPM file.</summary> + <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> + <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> + <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> + <param name="filename">a <see cref="T:System.String" /></param> + <returns>a <see cref="T:Gdk.Pixmap" /></returns> + <remarks>To be added</remarks> + </Docs> + </Member> + <Member MemberName="ColormapCreateFromXpmD"> + <MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpmD (Gdk.Drawable drawable, Gdk.Colormap colormap, out Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" /> + <MemberType>Method</MemberType> + <ReturnValue> + <ReturnType>Gdk.Pixmap</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="drawable" Type="Gdk.Drawable" /> + <Parameter Name="colormap" Type="Gdk.Colormap" /> + <Parameter Name="mask" Type="Gdk.Bitmap&" RefType="out" /> + <Parameter Name="transparent_color" Type="Gdk.Color" /> + <Parameter Name="data" Type="System.String" /> + </Parameters> + <Docs> + <summary>Create a pixmap from XPM data using a colormap.</summary> + <param name="drawable">a <see cref="T:Gdk.Drawable" /></param> + <param name="colormap">a <see cref="T:Gdk.Colormap" /></param> + <param name="mask">a <see cref="T:Gdk.Bitmap" /></param> + <param name="transparent_color">a <see cref="T:Gdk.Color" /></param> + <param name="data">a <see cref="T:System.String" /></param> + <returns>a <see cref="T:Gdk.Pixmap" /></returns> + <remarks>To be added</remarks> + </Docs> + </Member> </Members> -</Type> \ No newline at end of file +</Type> diff --git a/doc/en/Gtk/Init.xml b/doc/en/Gtk/Init.xml index 1f13e16a5..f4fa96e27 100644 --- a/doc/en/Gtk/Init.xml +++ b/doc/en/Gtk/Init.xml @@ -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 object that gets invoked at the beginning of an application but before the application main loop starts. It's used largely for application setup--- for example, reading RC files.</summary> - <remarks/> + <remarks /> </Docs> <Base> <BaseTypeName>System.Object</BaseTypeName> @@ -31,7 +31,7 @@ <Docs> <summary>Registers a function to be called when the mainloop is started. </summary> <param name="function">a <see cref="T:Gtk.Function" /></param> - <remarks/> + <remarks /> </Docs> </Member> <Member MemberName=".ctor"> @@ -46,72 +46,21 @@ </Docs> </Member> <Member MemberName="Check"> - <MemberSignature Language="C#" Value="public static bool Check (out int argc, string argv);" /> + <MemberSignature Language="C#" Value="public static bool Check (ref string [] argv);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> - <Parameter Name="argc" Type="System.Int32&" RefType="out" /> - <Parameter Name="argv" Type="System.String" /> + <Parameter Name="argv" Type="System.String[]&" RefType="ref" /> </Parameters> <Docs> - <summary>Initializes Gtk# for operation, probes window system. </summary> - <param name="argc">The number of if arguments. Changed if any arguments were handled.</param> - <param name="argv">a <see cref="T:System.String" /></param> + <summary>Initializes Gtk# for operation, probes window system.</summary> + <param name="argv">a <see cref="T:System.String[]" /></param> + <param name="argv">The command line arguments passed in. Changed if any arguments were handled.</param> <returns>True if the toolkit initialized correctly, false otherwise. </returns> - <remarks>Aside from the arguments, this function behaves in the same way as <see cref="T:Gtk.Application.InitCheck" />. Br returning whether or not the toolkit initialized correctly, it allows the application to fall back to a non-GUI interface, should the developer be so inclined to write one. - - -<block subset="none" type="note"> - <para>In Gtk# 0.98, this function's second argument is of type <see cref="T:System.String" />, when it should be an "out String[]". Until corrected, this function shall not work as expected. (FIXME 1.0: is this fixed?)</para> - </block></remarks> - </Docs> - </Member> - <Member MemberName="CheckAbiCheck"> - <MemberSignature Language="C#" Value="public static bool CheckAbiCheck (out int argc, string argv, int num_checks, int sizeof_GtkWindow, int sizeof_GtkBox);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>System.Boolean</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="argc" Type="System.Int32&" RefType="out" /> - <Parameter Name="argv" Type="System.String" /> - <Parameter Name="num_checks" Type="System.Int32" /> - <Parameter Name="sizeof_GtkWindow" Type="System.Int32" /> - <Parameter Name="sizeof_GtkBox" Type="System.Int32" /> - </Parameters> - <Docs> - <summary>To be added</summary> - <param name="argc">a <see cref="T:System.Int32&" /></param> - <param name="argv">a <see cref="T:System.String" /></param> - <param name="num_checks">a <see cref="T:System.Int32" /></param> - <param name="sizeof_GtkWindow">a <see cref="T:System.Int32" /></param> - <param name="sizeof_GtkBox">a <see cref="T:System.Int32" /></param> - <returns>a <see cref="T:System.Boolean" /></returns> - <remarks/> - </Docs> - </Member> - <Member MemberName="AbiCheck"> - <MemberSignature Language="C#" Value="public static int AbiCheck (string argv, int num_checks, int sizeof_GtkWindow, int sizeof_GtkBox);" /> - <MemberType>Method</MemberType> - <ReturnValue> - <ReturnType>System.Int32</ReturnType> - </ReturnValue> - <Parameters> - <Parameter Name="argv" Type="System.String" /> - <Parameter Name="num_checks" Type="System.Int32" /> - <Parameter Name="sizeof_GtkWindow" Type="System.Int32" /> - <Parameter Name="sizeof_GtkBox" Type="System.Int32" /> - </Parameters> - <Docs> - <summary>To be added</summary> - <param name="argv">a <see cref="T:System.String" /></param> - <param name="num_checks">a <see cref="T:System.Int32" /></param> - <param name="sizeof_GtkWindow">a <see cref="T:System.Int32" /></param> - <param name="sizeof_GtkBox">a <see cref="T:System.Int32" /></param> - <returns>a <see cref="T:System.Int32" /></returns> - <remarks/> + <remarks>Aside from the arguments, this function behaves in the same way as <see cref="T:Gtk.Application.InitCheck" />. By returning whether or not the toolkit initialized correctly, it allows the application to fall back to a non-GUI interface, should the developer be so inclined to write one. + </remarks> </Docs> </Member> </Members> diff --git a/doc/en/Gtk/Invisible.xml b/doc/en/Gtk/Invisible.xml index 1ca16e28e..16695b680 100644 --- a/doc/en/Gtk/Invisible.xml +++ b/doc/en/Gtk/Invisible.xml @@ -87,7 +87,7 @@ <summary>The screen this widget is attached to.</summary> <param name="value">a <see cref="T:Gdk.Screen" /></param> <returns>a <see cref="T:Gdk.Screen" /></returns> - <remarks/> + <remarks /> </Docs> </Member> <Member MemberName="GType"> @@ -117,5 +117,19 @@ <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks> </Docs> </Member> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Invisible (Gdk.Screen screen);" /> + <MemberType>Constructor</MemberType> + <ReturnValue /> + <Parameters> + <Parameter Name="screen" Type="Gdk.Screen" /> + </Parameters> + <Docs> + <summary>Public Constructor</summary> + <param name="screen">a <see cref="T:Gdk.Screen" /></param> + <returns>a <see cref="T:Gtk.Invisible" /></returns> + <remarks>Used to create a new <see cref="T:Gtk.Invisible" /> for a specific <see cref="T:Gdk.Screen" />.</remarks> + </Docs> + </Member> </Members> </Type> diff --git a/doc/en/Gtk/NodeStore.xml b/doc/en/Gtk/NodeStore.xml index f857b5169..79c16649d 100644 --- a/doc/en/Gtk/NodeStore.xml +++ b/doc/en/Gtk/NodeStore.xml @@ -95,5 +95,19 @@ </remarks> </Docs> </Member> + <Member MemberName="GType"> + <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" /> + <MemberType>Property</MemberType> + <ReturnValue> + <ReturnType>GLib.GType</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Native type value.</summary> + <returns>a <see cref="T:GLib.GType" /></returns> + <remarks> + </remarks> + </Docs> + </Member> </Members> -</Type> \ No newline at end of file +</Type>