<Type Name="Entry" FullName="Gnome.Entry"> <TypeSignature Language="C#" Value="public class Entry : Gtk.Combo, Editable, IWrapper, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <AssemblyInfo> <AssemblyName>gnome-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>A single-line text entry widget.</summary> <remarks> </remarks> </Docs> <Base> <BaseTypeName>Gtk.Combo</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>Gtk.Editable</InterfaceName> </Interface> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> <Interface> <InterfaceName>Atk.Implementor</InterfaceName> </Interface> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> <Interface> <InterfaceName>System.IDisposable</InterfaceName> </Interface> </Interfaces> <Attributes /> <Members> <Member MemberName="SelectRegion"> <MemberSignature Language="C#" Value="public virtual void SelectRegion (int start, int end);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.Int32" /> <Parameter Name="end" Type="System.Int32" /> </Parameters> <Docs> <summary>Select the text between <paramref name="start_pos" /> and <paramref name="end_pos" />.</summary> <param name="start">an object of type <see cref="T:System.Int32" /></param> <param name="end">an object of type <see cref="T:System.Int32" /></param> <remarks> </remarks> </Docs> </Member> <Member MemberName="GetChars"> <MemberSignature Language="C#" Value="public virtual string GetChars (int start_pos, int end_pos);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" /> </Parameters> <Docs> <summary>Gets the text between <paramref name="start_pos" /> and <paramref name="end_pos" />.</summary> <param name="start_pos">an object of type <see cref="T:System.Int32" /></param> <param name="end_pos">an object of type <see cref="T:System.Int32" /></param> <returns>an object of type <see cref="T:System.String" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="DeleteText"> <MemberSignature Language="C#" Value="public virtual void DeleteText (int start_pos, int end_pos);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" /> </Parameters> <Docs> <summary>Delete the text between <paramref name="start_pos" /> and <paramref name="end_pos" />.</summary> <param name="start_pos">an object of type <see cref="T:System.Int32" /></param> <param name="end_pos">an object of type <see cref="T:System.Int32" /></param> <remarks> </remarks> </Docs> </Member> <Member MemberName="CopyClipboard"> <MemberSignature Language="C#" Value="public virtual void CopyClipboard ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="DeleteSelection"> <MemberSignature Language="C#" Value="public virtual void DeleteSelection ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Delete the text contained in the selection.</summary> <remarks> </remarks> </Docs> </Member> <Member MemberName="GetSelectionBounds"> <MemberSignature Language="C#" Value="public virtual bool GetSelectionBounds (out int start, out int end);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start" Type="System.Int32&" RefType="out" /> <Parameter Name="end" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <summary>Determines the position of the beggining and end of a selection.</summary> <param name="start">an object of type <see cref="T:System.Int32" /></param> <param name="end">an object of type <see cref="T:System.Int32" /></param> <returns>an object of type <see cref="T:System.Boolean" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="CutClipboard"> <MemberSignature Language="C#" Value="public virtual void CutClipboard ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="PasteClipboard"> <MemberSignature Language="C#" Value="public virtual void PasteClipboard ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="PrependHistory"> <MemberSignature Language="C#" Value="public void PrependHistory (bool save, string text);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="save" Type="System.Boolean" /> <Parameter Name="text" Type="System.String" /> </Parameters> <Docs> <summary>Adds a history item of the given text to the head of the history list.</summary> <param name="save">an object of type <see cref="T:System.Boolean" /></param> <param name="text">an object of type <see cref="T:System.String" /></param> <remarks>If save is <see langword="true" />, the history item will be saved in the config file (assuming that <see cref="P:Gnome.Entry.HistoryId" /> is not <see langword="null" />). Duplicates are automatically removed from the history list. The history list is automatically saved if needed.</remarks> </Docs> </Member> <Member MemberName="Construct"> <MemberSignature Language="C#" Value="public void Construct (string history_id);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="history_id" Type="System.String" /> </Parameters> <Docs> <summary>To be added</summary> <param name="history_id">an object of type <see cref="T:System.String" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="ClearHistory"> <MemberSignature Language="C#" Value="public void ClearHistory ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Clears the history.</summary> <remarks> </remarks> </Docs> </Member> <Member MemberName="AppendHistory"> <MemberSignature Language="C#" Value="public void AppendHistory (bool save, string text);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="save" Type="System.Boolean" /> <Parameter Name="text" Type="System.String" /> </Parameters> <Docs> <summary>Adds a history item of the given text to the tail of the history list.</summary> <param name="save">an object of type <see cref="T:System.Boolean" /></param> <param name="text">an object of type <see cref="T:System.String" /></param> <remarks>If save is <see langword="true" />, the history item will be saved in the config file (assuming that <see cref="P:Gnome.Entry.HistoryId" /> is not <see langword="null" />). Duplicates are automatically removed from the history list. The history list is automatically saved if needed.</remarks> </Docs> </Member> <Member MemberName="Finalize"> <MemberSignature Language="C#" Value="protected override void Finalize ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Disposes the resources associated with the object.</summary> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Entry (IntPtr raw);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="raw" Type="System.IntPtr" /> </Parameters> <Docs> <summary>Internal constructor</summary> <param name="raw">Pointer to the C object.</param> <returns>An instance of Entry, wrapping the C object.</returns> <remarks> <para>This is an internal constructor, and should not be used by user code.</para> </remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Entry (string history_id);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="history_id" Type="System.String" /> </Parameters> <Docs> <summary>Creates a new <see cref="T:Gnome.Entry" /> instance.</summary> <param name="history_id">an object of type <see cref="T:System.String" /></param> <returns>an object of type <see cref="T:Gnome.Entry" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Entry ();" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters /> <Docs> <summary>Internal constructor</summary> <returns>an object of type <see cref="T:Gnome.Entry" /></returns> <remarks>This is a constructor used by derivative types of <see cref="T:Gnome.Entry" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</remarks> </Docs> </Member> <Member MemberName="IsEditable"> <MemberSignature Language="C#" Value="public virtual bool IsEditable { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>Whether the <see cref="T:Gnome.Entry" /> is editable by the user.</summary> <param name="value">an object of type <see cref="T:System.Boolean" /></param> <returns>an object of type <see cref="T:System.Boolean" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="Position"> <MemberSignature Language="C#" Value="public virtual int Position { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>The position of the cursor in the entry.</summary> <param name="value">an object of type <see cref="T:System.Int32" /></param> <returns>an object of type <see cref="T:System.Int32" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="MaxSaved"> <MemberSignature Language="C#" Value="public uint MaxSaved { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.UInt32</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>Internal limit on number of history items saved to the config file.</summary> <param name="value">an object of type <see cref="T:System.UInt32" /></param> <returns>an object of type <see cref="T:System.UInt32" /></returns> <remarks>Zero is an acceptable value, but the same thing is accomplished by setting the <see cref="P:Gnome.Entry.HistoryId" /> to <see langword="null" />.</remarks> </Docs> </Member> <Member MemberName="GtkEntry"> <MemberSignature Language="C#" Value="public Gtk.Entry GtkEntry { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>Gtk.Entry</ReturnType> </ReturnValue> <Docs> <summary>The internal <see cref="T:Gtk.Entry" /> of the <see cref="T:Gnome.Entry" />.</summary> <returns>an object of type <see cref="T:Gtk.Entry" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="HistoryId"> <MemberSignature Language="C#" Value="public string HistoryId { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> </Parameters> <Docs> <summary>The history id of the <see cref="T:Gnome.Entry" /> widget.</summary> <param name="value">an object of type <see cref="T:System.String" /></param> <returns>an object of type <see cref="T:System.String" /></returns> <remarks> </remarks> </Docs> </Member> <Member MemberName="TextInserted"> <MemberSignature Language="C#" Value="public virtual event GtkSharp.TextInsertedHandler TextInserted;" /> <MemberType>Event</MemberType> <ReturnValue> <ReturnType>GtkSharp.TextInsertedHandler</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Emitted when text is inserted into the entry.</summary> <remarks> </remarks> </Docs> </Member> <Member MemberName="TextDeleted"> <MemberSignature Language="C#" Value="public virtual event GtkSharp.TextDeletedHandler TextDeleted;" /> <MemberType>Event</MemberType> <ReturnValue> <ReturnType>GtkSharp.TextDeletedHandler</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Emitted when text is deleted from the entry.</summary> <remarks> </remarks> </Docs> </Member> <Member MemberName="Changed"> <MemberSignature Language="C#" Value="public virtual event EventHandler Changed;" /> <MemberType>Event</MemberType> <ReturnValue> <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Emitted when the text is changed.</summary> <remarks> </remarks> </Docs> </Member> <Member MemberName="Activated"> <MemberSignature Language="C#" Value="public event EventHandler Activated;" /> <MemberType>Event</MemberType> <ReturnValue> <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Emitted when the <see cref="T:Gnome.Entry" /> is activated.</summary> <remarks>This usually occurs when the user presses the "enter" or "return" key.</remarks> </Docs> </Member> <Member MemberName="InsertText"> <MemberSignature Language="C#" Value="public virtual void InsertText (string new_text, ref int position);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="new_text" Type="System.String" /> <Parameter Name="position" Type="System.Int32&" RefType="ref" /> </Parameters> <Docs> <summary>To be added</summary> <param name="new_text">an object of type <see cref="T:System.String" /></param> <param name="position">an object of type <see cref="T:System.Int32" /></param> <remarks>To be added</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>To be added</summary> <returns>a <see cref="T:GLib.GType" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OverrideActivated"> <MemberSignature Language="C#" Value="protected static void OverrideActivated (GLib.GType gtype);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="gtype" Type="GLib.GType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="gtype">a <see cref="T:GLib.GType" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OverrideChanged"> <MemberSignature Language="C#" Value="protected static void OverrideChanged (GLib.GType gtype);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="gtype" Type="GLib.GType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="gtype">a <see cref="T:GLib.GType" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OverrideTextDeleted"> <MemberSignature Language="C#" Value="protected static void OverrideTextDeleted (GLib.GType gtype);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="gtype" Type="GLib.GType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="gtype">a <see cref="T:GLib.GType" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OverrideTextInserted"> <MemberSignature Language="C#" Value="protected static void OverrideTextInserted (GLib.GType gtype);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="gtype" Type="GLib.GType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="gtype">a <see cref="T:GLib.GType" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OnActivated"> <MemberSignature Language="C#" Value="protected virtual void OnActivated ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OnChanged"> <MemberSignature Language="C#" Value="protected virtual void OnChanged ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OnTextDeleted"> <MemberSignature Language="C#" Value="protected virtual void OnTextDeleted (int start_pos, int end_pos);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="start_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" /> </Parameters> <Docs> <summary>To be added</summary> <param name="start_pos">a <see cref="T:System.Int32" /></param> <param name="end_pos">a <see cref="T:System.Int32" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="OnTextInserted"> <MemberSignature Language="C#" Value="protected virtual void OnTextInserted (string text, out int position);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="text" Type="System.String" /> <Parameter Name="position" Type="System.Int32&" RefType="out" /> </Parameters> <Docs> <summary>To be added</summary> <param name="text">a <see cref="T:System.String" /></param> <param name="position">a <see cref="T:System.Int32&" /></param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Entry (GLib.GType gtype);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="gtype" Type="GLib.GType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="gtype">a <see cref="T:GLib.GType" /></param> <returns>a <see cref="T:Gnome.Entry" /></returns> <remarks>To be added</remarks> </Docs> </Member> </Members> </Type>