My contributions

svn path=/trunk/gtk-sharp/; revision=30201
This commit is contained in:
Miguel de Icaza 2004-06-23 14:45:23 +00:00
parent 04239d80db
commit 5767c36072
5 changed files with 107 additions and 72 deletions

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>Standard and pixmap cursors</summary>
<remarks>The <see cref="T:Gdk.Cursor" /> represents cursors.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,9 +27,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Cursor'</returns>
<remarks>To be added</remarks>
<summary>Adds a reference to the cursor</summary>
<returns>Same cursor that was passed in.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Unref">
@ -40,8 +40,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Removes a reference from cursor, deallocating the cursor if no references remain.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Display">
@ -51,9 +51,9 @@
<ReturnType>Gdk.Display</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns>
<remarks>To be added</remarks>
<summary>Returns the display on which the <see cref="T:Gdk.Cursor" /> is defined.</summary>
<returns>The <see cref="T:Gdk.Display" /> where the cursor is defined.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -78,10 +78,13 @@
<Parameter Name="cursor_type" Type="Gdk.CursorType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="cursor_type">a <see cref="T:Gdk.CursorType" /></param>
<summary>Creates a cursor from standard definitions.</summary>
<param name="cursor_type">The cursor type.</param>
<returns>a <see cref="T:Gdk.Cursor" /></returns>
<remarks>To be added</remarks>
<remarks>Creates a new cursor from the set of builtin cursors for the default display. See gdk_cursor_new_for_display().
<para>
To make the cursor invisible, use gdk_cursor_new_from_pixmap() to create a cursor with no pixels in it.
</para></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -113,15 +116,24 @@
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="source">a <see cref="T:Gdk.Pixmap" /></param>
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
<param name="fg">a <see cref="T:Gdk.Color" /></param>
<param name="bg">a <see cref="T:Gdk.Color" /></param>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<summary>Creates a new cursor from a given pixmap and mask.</summary>
<param name="source">The <see cref="T:Gdk.Pixmap" /> the pixmap specifying the cursor. </param>
<param name="mask">The <see cref="T:Gdk.Pixmap" /> specifying the mask, which must be the same size as source.</param>
<param name="fg">the foreground color, used for the bits in the source which are 1. The color does not have to be allocated first.</param>
<param name="bg"> the background color, used for the bits in the source which are 0. The color does not have to be allocated first.</param>
<param name="x"> the horizontal offset of the 'hotspot' of the cursor.</param>
<param name="y"> the vertical offset of the 'hotspot' of the cursor.</param>
<returns>a <see cref="T:Gdk.Cursor" /></returns>
<remarks>To be added</remarks>
<remarks>Creates a new cursor from a given pixmap and mask. Both the pixmap and mask must have a depth of 1 (i.e. each pixel has only 2 values - on or off). The standard cursor size is 16 by 16 pixels.
<example>
<code lang="C#">
Gdk.Pixmap pixmap = GetPixmap ();
Gdk.Bitmap mask = GetMask ();
Gdk.Cursor cursor = new Gdk.Cursor (pixmap, mask);
</code>
</example></remarks>
</Docs>
</Member>
<Member MemberName="GType">

View File

@ -10,8 +10,11 @@
</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>Offscreen drawable.</summary>
<remarks>Pixmaps are offscreen drawables. They can be drawn upon with the standard drawing primitives, then copied to another drawable (such as a <see cref="T:Gdk.Window" />) with <see cref="M:Gdk.Pixmap.Draw()" />.
<para>
The depth of a pixmap is the number of bits per pixels. Bitmaps are simply pixmaps with a depth of 1. (That is, they are monochrome bitmaps - each pixel can be either on or off).
</para></remarks>
</Docs>
<Base>
<BaseTypeName>Gdk.Drawable</BaseTypeName>
@ -36,10 +39,13 @@
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="anid">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
<summary>Looks up the <see cref="T:Gdk.Pixmap" /> that wraps the given native pixmap handle.</summary>
<param name="anid"> a native pixmap handle.</param>
<returns> the <see cref="T:Gdk.Window" /> wrapper for the native window, or <see langword="null" /> if there is none.</returns>
<remarks>Looks up the GdkPixmap that wraps the given native pixmap handle.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></remarks>
</Docs>
</Member>
<Member MemberName="ForeignNew">
@ -52,10 +58,13 @@
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="anid">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
<summary>Wraps a native window for the default display in a <see cref="T:Gdk.Pixmap" />. This may fail if the pixmap has been destroyed.</summary>
<param name="anid"> a native pixmap handle.</param>
<returns>The newly-created <see cref="T:Gdk.Pixmap" /> wrapper for the native pixmap or <see langword="null" /> if the pixmap has been destroyed.</returns>
<remarks>Wraps a native window for the default display in a GdkPixmap. This may fail if the pixmap has been destroyed.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -161,11 +170,14 @@
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="anid">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
<summary>Wraps a native pixmap in a <see cref="T:Gdk.Pixmap" />. This may fail if the pixmap has been destroyed.</summary>
<param name="display">The <see cref="T:Gdk.Display" /> where the pixmap is located.</param>
<param name="anid"> a native pixmap handle.</param>
<returns>The newly-created <see cref="T:Gdk.Pixmap" /> wrapper for the native pixmap or <see langword="null" /> if the pixmap has been destroyed.</returns>
<remarks>Wraps a native pixmap in a GdkPixmap. This may fail if the pixmap has been destroyed.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpm">
@ -182,14 +194,14 @@
<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="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>
<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>To be added</remarks>
<remarks>Create a pixmap from a XPM file using a particular colormap.</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpmD">
@ -253,13 +265,14 @@
<Parameter Name="depth" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="depth">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
<summary>Creates a new pixmap with the given size and depth.</summary>
<param name="drawable">A <see cref="T:Gdk.Drawable" />, used to determine default values for the new pixmap.
Can be <see langword="null" /> if <paramref name="depth" /> is specified</param>
<param name="width">The width of the new pixmap in pixels.</param>
<param name="height"> The height of the new pixmap in pixels.</param>
<param name="depth">The depth (number of bits per pixel) of the new pixmap. If -1, and drawable is not <see langword="null" />, the depth of the new pixmap will be equal to that of drawable.</param>
<returns>The new pixmap with the given size and depth</returns>
<remarks>Create a new pixmap with a given size and depth. </remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -299,12 +312,12 @@
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
<summary>Create a new pixmap using a reference drawable for depth.</summary>
<param name="drawable">A <see cref="T:Gdk.Drawable" />, used to determine default values for the new pixmap.</param>
<param name="width">The width of the new pixmap in pixels.</param>
<param name="height">The height of the new pixmap in pixels.</param>
<returns>The new <see cref="T:Gdk.Pixmap" />.</returns>
<remarks>Creates a new pixmap with a given size and depth.</remarks>
</Docs>
</Member>
</Members>

View File

@ -932,10 +932,14 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Cursor'</param>
<returns>To be added: an object of type 'Gdk.Cursor'</returns>
<remarks>To be added</remarks>
<summary>Sets the cursor for the window.</summary>
<param name="value">The cursor</param>
<returns />
<remarks>Sets the mouse pointer for a <see cref="T:Gdk.Window" />.
<para>
To make the cursor invisible, use pixmap constructor for the cursor to create a cursor with no pixels in it. Passing <see langword="null" /> for the cursor argument to this property means that window will use the cursor of its parent window. Most windows should use this default.
</para></remarks>
</Docs>
</Member>
<Member MemberName="Events">
@ -1073,10 +1077,13 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<summary>Sets the background color for the window.</summary>
<param name="value">The color</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<remarks>Sets the background color of window. (However, when using GTK+, set the background of a widget with <see cref="M:Gtk.Widget.ModifyBg(Gtk.StateType, Gdk.Color)" /> - if you're an application - or <see cref="M:Gtk.Style.SetBackground(Gdk.Window, Gtk.StateType)" /> - if you're implementing a custom widget.
<para>
The color must be allocated;
</para></remarks>
</Docs>
</Member>
<Member MemberName="Parent">
@ -1395,9 +1402,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Window[]" /></returns>
<remarks>To be added</remarks>
<summary>Gets the children of window known to Gdk. </summary>
<returns>The array of windows.</returns>
<remarks>This function only returns children created via GDK, so for example it's useless when used with the root window; it only returns windows an application created itself.</remarks>
</Docs>
</Member>
<Member MemberName="IconList">

View File

@ -86,7 +86,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Fullscreen window.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View File

@ -16,7 +16,10 @@
of function the window has. The window manager can use this when
determining decoration and behaviour of the window. The hint
must be set before mapping the window.
</remarks>
<para>
These map to the FreeDesktop WM specification (http://freedesktop.org/Standards/wm-spec/)
</para></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -91,7 +94,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Indicates that the window is a splash screen displayed as an application is starting up.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -104,7 +107,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Indicates a small persistent utility window, such as a palette or toolbox. It is distinct from type Toolbar because it does not correspond to a toolbar torn off from the main application. It's distinct from type Dialog because it isn't a transient dialog, the user will probably keep it open while they're working. </summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -117,7 +120,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Indicates a dock or panel feature. Typically a Window Manager would keep such windows on top of all other windows.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -130,7 +133,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Indicates a desktop feature. This can include a single window containing desktop icons with the same dimensions as the screen, allowing the desktop environment to have full control of the desktop, without the need for proxying root window clicks.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>