<Type Name="Cursor" FullName="Gdk.Cursor"> <TypeSignature Language="C#" Value="public sealed struct Cursor;" Maintainer="auto" /> <AssemblyInfo> <AssemblyName>gdk-sharp</AssemblyName> <AssemblyPublicKey> </AssemblyPublicKey> <AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyCulture>neutral</AssemblyCulture> <Attributes /> </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>Standard and pixmap cursors</summary> <remarks>The <see cref="T:Gdk.Cursor" /> represents cursors.</remarks> </Docs> <Base> <BaseTypeName>System.ValueType</BaseTypeName> </Base> <Interfaces /> <Attributes /> <Members> <Member MemberName="Ref"> <MemberSignature Language="C#" Value="public Gdk.Cursor Ref ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Gdk.Cursor</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Adds a reference to the cursor</summary> <returns>Same cursor that was passed in.</returns> <remarks /> </Docs> </Member> <Member MemberName="Unref"> <MemberSignature Language="C#" Value="public void Unref ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Removes a reference from cursor, deallocating the cursor if no references remain.</summary> <remarks /> </Docs> </Member> <Member MemberName="Display"> <MemberSignature Language="C#" Value="public Gdk.Display Display { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Gdk.Display</ReturnType> </ReturnValue> <Docs> <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"> <MemberSignature Language="C#" Value="public Cursor (IntPtr raw);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="raw" Type="System.IntPtr" /> </Parameters> <Docs> <summary>Internal constructor.</summary> <param name="raw">raw managed pointer.</param> <returns>A new <see cref="T:Gdk.Cursor" />.</returns> <remarks>This is an internal constructor, do not use it.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Cursor (Gdk.CursorType cursor_type);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="cursor_type" Type="Gdk.CursorType" /> </Parameters> <Docs> <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>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"> <MemberSignature Language="C#" Value="public Cursor (Gdk.Display display, Gdk.CursorType cursor_type);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="display" Type="Gdk.Display" /> <Parameter Name="cursor_type" Type="Gdk.CursorType" /> </Parameters> <Docs> <summary>Creates a new cursor from the set of builtin cursors.</summary> <param name="display">The <see cref="T:Gdk.Display" /> for which the cursor will be created.</param> <param name="cursor_type">Cursor to create.</param> <returns>A new <see cref="T:Gdk.Cursor" />.</returns> <remarks>None.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Cursor (Gdk.Pixmap source, Gdk.Pixmap mask, Gdk.Color fg, Gdk.Color bg, int x, int y);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="source" Type="Gdk.Pixmap" /> <Parameter Name="mask" Type="Gdk.Pixmap" /> <Parameter Name="fg" Type="Gdk.Color" /> <Parameter Name="bg" Type="Gdk.Color" /> <Parameter Name="x" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> <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>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"> <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>GLib.GType</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>GType Property.</summary> <returns>a <see cref="T:GLib.GType" /></returns> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.Cursor" />.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Cursor (Gdk.Display display, Gdk.Pixbuf pixbuf, int x, int y);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="display" Type="Gdk.Display" /> <Parameter Name="pixbuf" Type="Gdk.Pixbuf" /> <Parameter Name="x" Type="System.Int32" /> <Parameter Name="y" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="display">a <see cref="T:Gdk.Display" /></param> <param name="pixbuf">a <see cref="T:Gdk.Pixbuf" /></param> <param name="x">a <see cref="T:System.Int32" /></param> <param name="y">a <see cref="T:System.Int32" /></param> <returns>a <see cref="T:Gdk.Cursor" /></returns> <remarks>To be added</remarks> </Docs> </Member> </Members> </Type>