ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-29 15:55:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
GtkSharp/doc/en/Gtk/Entry.xml
John Luke 8855f7a5a7 add some automatic docs for the new stuff 
svn path=/trunk/gtk-sharp/; revision=43452
2005-04-22 17:20:16 +00:00

1178 lines
49 KiB
XML
Raw Blame History

<Type Name="Entry" FullName="Gtk.Entry">
<TypeSignature Language="C#" Value="public class Entry : Gtk.Widget, Editable, IWrapper, CellEditable, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
<AssemblyInfo>
<AssemblyName>gtk-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>An Entry is a single-line text entry widget.</summary>
<remarks>
<para>This widget should be used to retrieve small amounts of text from the user. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.</para>
<para>
See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing large amounts of text.
</para>
<example>
<code lang="C#">
using System;
using Gtk;
class EntrySample
{
Entry entry;
static void Main ()
{
new EntrySample ();
}
EntrySample ()
{
Application.Init ();
Window win = new Window ("EntrySample");
win.SetDefaultSize (200, 150);
win.DeleteEvent += new DeleteEventHandler (OnWinDelete);
VBox vbox = new VBox (false, 1);
win.Add (vbox);
entry = new Entry ("hello world");
entry.Editable = true;
entry.Visibility = true;
vbox.Add (entry);
CheckButton editable = new CheckButton ("Editable");
editable.Toggled += new EventHandler (OnEditableToggled);
editable.Active = true;
vbox.Add (editable);
CheckButton visibility = new CheckButton ("Visibility");
visibility.Toggled += new EventHandler (OnVisibilityToggled);
visibility.Active = true;
vbox.Add (visibility);
win.ShowAll ();
Application.Run ();
}
void OnEditableToggled (object obj, EventArgs args)
{
entry.Editable = !entry.Editable;
}
void OnVisibilityToggled (object obj, EventArgs args)
{
entry.Visibility = !entry.Visibility;
}
void OnWinDelete (object obj, DeleteEventArgs args)
{
Application.Quit ();
}
}
</code>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.Editable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Gtk.CellEditable</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="InsertText">
<MemberSignature Language="C#" Value="public int InsertText (string new_text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_text" Type="System.String" />
</Parameters>
<Docs>
<summary>Add arbitrary text to the entry.</summary>
<param name="new_text">the text to add</param>
<returns>
<para>The number of characters added.</para>
</returns>
<remarks>
<para>Use this method to insert a string at the current CursorPosition.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="StartEditing">
<MemberSignature Language="C#" Value="public virtual void StartEditing (Gdk.Event evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>Specific implementation of Gtk.CellEditable.StartEditing for the Entry widget.</summary>
<param name="evnt" />
<remarks />
</Docs>
</Member>
<Member MemberName="FinishEditing">
<MemberSignature Language="C#" Value="public virtual void FinishEditing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Specific implementation of Gtk.CellEditable.FinishEditing for the Entry widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RemoveWidget">
<MemberSignature Language="C#" Value="public virtual void RemoveWidget ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Specific implementation of Gtk.CellEditable.RemoveWidget for the Entry widget.</summary>
<remarks />
</Docs>
</Member>
<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>Specific implementation of Gtk.Editable.SelectRegion for the Entry widget.</summary>
<param name="start" />
<param name="end" />
<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>Specific implementation of Gtk.Editable.GetChars for the Entry widget.</summary>
<param name="start_pos">The index of the first character to get, (zero-indexed).</param>
<param name="end_pos">The index of the character to retrieve up to.</param>
<returns>
<para>A string representing the characters from <paramref name="start_pos" />, up to, but not including <paramref name="end_pos" />. If <paramref name="end_pos" /> is negative, then the the characters retrieved will be those characters from <paramref name="start_pos" /> to the end of the text.</para>
</returns>
<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>Specific implementation of Gtk.Editable.DeleteText for the Entry widget.</summary>
<param name="start_pos" />
<param name="end_pos" />
<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>Specific implementation of Gtk.Editable.CopyClipboard for the Entry widget.</summary>
<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>Specific implementation of Gtk.Editable.DeleteSelection for the Entry widget. Deletes the currently selected text from the Entry.</summary>
<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&amp;" RefType="out" />
<Parameter Name="end" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Get the the positions of the start and end of the current selection, if there is one.</summary>
<param name="start">output variable for the character index of the selection start</param>
<param name="end">output variable for the character index of the end of the selection</param>
<returns>
<para>
<see langword="true" /> if there is a selection, <see cref="langword:false" /> otherwise.</para>
</returns>
<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>Copies any selected text to the clipboard and deletes it from the entry.</summary>
<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>Causes the contents of the clipboard to be pasted into the Entry at the current cursor position.</summary>
<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 ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Construct a new entry widget</summary>
<returns>Creates an entry widget with empty contents</returns>
<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>Implements the concrete version of Gtk.Editable.IsEditable, to determine if the text of the Entry can be edited.</summary>
<param name="value">true to allow editing of the Entry, false otherwise.</param>
<returns>
<para>true if the Entry is editable, false otherwise.</para>
</returns>
<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.</summary>
<param name="value">the new cursor position, in characters.</param>
<returns>
<para>the current cursor position</para>
</returns>
<remarks>
<para>The cursor is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes. </para>
</remarks>
</Docs>
</Member>
<Member MemberName="Layout">
<MemberSignature Language="C#" Value="public Pango.Layout Layout { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.Layout</ReturnType>
</ReturnValue>
<Docs>
<summary>Get the object used by this Entry for text layout.</summary>
<returns>
<para>The Pango.Layout used to render the text of this entry.</para>
</returns>
<remarks>
<para>This property is read only.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Visibility">
<MemberSignature Language="C#" Value="public bool Visibility { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Determine whether to display characters entered, or whether to mask them.</summary>
<param name="value">true to display characters in the Entry, false to mask them</param>
<returns>
<para>true if characters are being displayed, false if they are being masked.</para>
</returns>
<remarks>
<para>This property should be used to create entry widgets for sensitive data such as passwords.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxLength">
<MemberSignature Language="C#" Value="public int MaxLength { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The maximum number of characters that can be placed in this Entry.</summary>
<param name="value">How many characters to limit this Entry to</param>
<returns>
<para>The maximum number of characters that can currently be set in this Entry.</para>
</returns>
<remarks>
<para>This property can be useful for ensuring no more than a specific number of characters are put in an entry.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CursorPosition">
<MemberSignature Language="C#" Value="public int CursorPosition { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The position of the cursor in the text of the Entry.</summary>
<returns>
<para>The current character of the cursor.</para>
</returns>
<remarks>
<para>Use this property to manipulate the position of the cursor - it is displayed before the character with the given (base 0) index in the widget. The value must be less than or equal to the number of characters in the widget. A value of -1 indicates that the position should be set after the last character in the entry. Note that this position is in characters, not in bytes.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SelectionBound">
<MemberSignature Language="C#" Value="public int SelectionBound { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The length of the selected text.</summary>
<returns>
<para>The number of selected characters.</para>
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Manipulate the current text contents of an Entry.</summary>
<param name="value">The new string to display in the Entry - overwrites any existing text in the widget.</param>
<returns>
<para>The current text in an Entry.</para>
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ScrollOffset">
<MemberSignature Language="C#" Value="public int ScrollOffset { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Number of pixels the entry scrolled off the screen to the left.</summary>
<returns>A <see cref="T:System.Int32" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="WidthChars">
<MemberSignature Language="C#" Value="public int WidthChars { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Changes the size request of the entry to be about the right size for <paramref name="n_chars" /> characters.</summary>
<param name="value">Requested width, in characters</param>
<returns>
<para>The number of characters requested.</para>
</returns>
<remarks>
<para>Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Editable">
<MemberSignature Language="C#" Value="public bool Editable { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether or not this Entry is editable.</summary>
<param name="value">
<para>
<see langword="true" /> to make this Entry read-only, <see langword="false" /> to allow editing.</para>
</param>
<returns>
<para>
<see langword="true" /> if this entry can be edited, <see langword="false" /> otherwise.</para>
</returns>
<remarks>
<para>Set this property to false if you need to stop input into an Entry widget. For displaying textual data, it is more normal to use a <see cref="T:Gtk.Label" /> instead.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ActivatesDefault">
<MemberSignature Language="C#" Value="public bool ActivatesDefault { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Determine whether to activate the 'default widget' in the window when the return key is pressed.</summary>
<param name="value">set to <see langword="true" /> to activate the default button when enter is pressed, <see langword="false" /> otherwise</param>
<returns>
<para>
<see langword="true" /> if the default button will be activated, false otherwise.</para>
</returns>
<remarks>
<para>If the value is <see langword="true" />, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.</para>
<para>
(For experts: if the value is <see langword="true" />, the entry calls <see cref="M:Gtk.Window.ActivateDefault" /> on the <see cref="T:Gtk.Window" /> containing the entry, in the default handler for the <see cref="E:Gtk.Window.Activated" /> event).</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HasFrame">
<MemberSignature Language="C#" Value="public bool HasFrame { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether or not this Entry should be surrounded by a 3D frame.</summary>
<param name="value">
<see langword="true" /> to surround this Entry in a frame (the default), <see langword="false" /> otherwise.</param>
<returns>
<see langword="true" /> if a frame surrounds this Entry, <see langword="false" /> otherwise</returns>
<remarks>
<para>Unless there is a very specific reason for doing so, this property is best left to its default to ensure consistency in Entry widgets across applications.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="WidgetRemoved">
<MemberSignature Language="C#" Value="public virtual event EventHandler WidgetRemoved;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implements the WidgetRemoved method of the <see cref="T:Gtk.CellEditable" /> interface. This will effectively destroy the Entry.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="EditingDone">
<MemberSignature Language="C#" Value="public virtual event EventHandler EditingDone;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implements the EditingDone method of the <see cref="T:Gtk.CellEditable" /> interface.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TextInserted">
<MemberSignature Language="C#" Value="public virtual event Gtk.TextInsertedHandler TextInserted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when text is inserted into the Entry.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TextDeleted">
<MemberSignature Language="C#" Value="public virtual event Gtk.TextDeletedHandler TextDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when text is deleted from the Entry.</summary>
<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>When the contents of the Entry change, this event is fired.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MoveCursor">
<MemberSignature Language="C#" Value="public event Gtk.MoveCursorHandler MoveCursor;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.MoveCursorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event handler to be notified when the cursor of an Entry moves.</summary>
<remarks>Data pertaining to this event is passed with a <see cref="T:Gtk.MoveCursorHandler" />.</remarks>
</Docs>
</Member>
<Member MemberName="ClipboardCut">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardCut;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the user 'cuts' a selection in the Entry.</summary>
<remarks>Connect to this event with a standard <see cref="T:System.EventHandler" />.</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>Connect to this event to be notified when the user hits 'return'.</summary>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DeleteFromCursor">
<MemberSignature Language="C#" Value="public event Gtk.DeleteFromCursorHandler DeleteFromCursor;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.DeleteFromCursorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to find out when text is deleted from the Entry by the user.</summary>
<remarks>
<para>Data pertaining to this event is encapsulated in a <see cref="T:Gtk.DeleteFromCursorHandler" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ClipboardPasted">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardPasted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the clipboard contents are pasted into this Entry.</summary>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ClipboardCopied">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardCopied;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the contents of the Entry are copied to the clipboard.</summary>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PopulatePopup">
<MemberSignature Language="C#" Value="public event Gtk.PopulatePopupHandler PopulatePopup;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.PopulatePopupHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Fired when the popup handler needs to be filled with data.</summary>
<remarks>
<para>Data pertaining to this event is encapsulated in a <see cref="T:Gtk.PopulatePopupArgs" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ToggleOverwrite">
<MemberSignature Language="C#" Value="public event EventHandler ToggleOverwrite;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to discover when the Overwrite state has been changed by the user. This is usually done by pressing the 'Insert' key on a keyboard.</summary>
<remarks>
<para>Connect to this event with a standard <see cref="T:System.EventHandler" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="InsertAtCursor">
<MemberSignature Language="C#" Value="public event Gtk.InsertAtCursorHandler InsertAtCursor;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.InsertAtCursorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to discover when text is inserted at the cursor position - usually when the user types something in.</summary>
<remarks>
<para>Data pertaining to this event is encapsulated in an <see cref="T:Gtk.InsertAtCursorHandler" />.</para>
</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&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Add text <paramref name="new_text" /> to the entry just before <paramref name="position" />.</summary>
<param name="new_text">A <see cref="System.String" /></param>
<param name="position">A <see cref="System.Int32&amp;" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Entry (string initialText);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="initialText" Type="System.String" />
</Parameters>
<Docs>
<summary>Public constructor.</summary>
<param name="initialText">A <see cref="System.String" /></param>
<returns>A <see cref="T:Gtk.Entry" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetLayoutOffsets">
<MemberSignature Language="C#" Value="public void GetLayoutOffsets (out int x, out int y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="y" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Obtains the position of the PangoLayout used to render text in the entry, in widget coordinates.</summary>
<param name="x">X offset output of the layout.</param>
<param name="y">Y offset output of the layout.</param>
<remarks>
<para>Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.</para>
- <para>Also useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the entry text is clicked.</para></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:Gtk.Entry" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnInsertAtCursor">
<MemberSignature Language="C#" Value="protected virtual void OnInsertAtCursor (string str);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str" Type="System.String" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.InsertAtCursor" /> event.</summary>
<param name="str">a <see cref="T:System.String" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.InsertAtCursor" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnToggleOverwrite">
<MemberSignature Language="C#" Value="protected virtual void OnToggleOverwrite ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.ToggleOverwrite" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.ToggleOverwrite" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnPopulatePopup">
<MemberSignature Language="C#" Value="protected virtual void OnPopulatePopup (Gtk.Menu menu);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="menu" Type="Gtk.Menu" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.PopulatePopup" /> event.</summary>
<param name="menu">a <see cref="T:Gtk.Menu" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.PopulatePopup" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnClipboardCopied">
<MemberSignature Language="C#" Value="protected virtual void OnClipboardCopied ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.ClipboardCopied" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.ClipboardCopied" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnClipboardPasted">
<MemberSignature Language="C#" Value="protected virtual void OnClipboardPasted ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.ClipboardPasted" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.ClipboardPasted" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnDeleteFromCursor">
<MemberSignature Language="C#" Value="protected virtual void OnDeleteFromCursor (Gtk.DeleteType type, int count);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Gtk.DeleteType" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.DeleteFromCursor" /> event.</summary>
<param name="type">a <see cref="T:Gtk.DeleteType" /></param>
<param name="count">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.DeleteFromCursor" /> event.</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>Default handler for the <see cref="M:Gtk.Entry.Activated" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.Activated" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnClipboardCut">
<MemberSignature Language="C#" Value="protected virtual void OnClipboardCut ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.ClipboardCut" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.ClipboardCut" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnMoveCursor">
<MemberSignature Language="C#" Value="protected virtual void OnMoveCursor (Gtk.MovementStep step, int count, bool extend_selection);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="step" Type="Gtk.MovementStep" />
<Parameter Name="count" Type="System.Int32" />
<Parameter Name="extend_selection" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.MoveCursor" /> event.</summary>
<param name="step">a <see cref="T:Gtk.MovementStep" /></param>
<param name="count">a <see cref="T:System.Int32" /></param>
<param name="extend_selection">a <see cref="T:System.Boolean" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.MoveCursor" /> event.</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>Default handler for the <see cref="M:Gtk.Entry.Changed" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.Changed" /> event.</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>Default handler for the <see cref="M:Gtk.Entry.TextDeleted" /> event.</summary>
<param name="start_pos">a <see cref="T:System.Int32" /></param>
<param name="end_pos">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.TextDeleted" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnTextInserted">
<MemberSignature Language="C#" Value="protected virtual void OnTextInserted (string text, ref int position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.TextInserted" /> event.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="position">a <see cref="T:System.Int32&amp;" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.TextInserted" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnEditingDone">
<MemberSignature Language="C#" Value="protected virtual void OnEditingDone ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.EditingDone" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.EditingDone" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnWidgetRemoved">
<MemberSignature Language="C#" Value="protected virtual void OnWidgetRemoved ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.WidgetRemoved" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.WidgetRemoved" /> event.</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>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.Entry" /></returns>
<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="Xalign">
<MemberSignature Language="C#" Value="public float Xalign { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The horizontal alignment, from 0 (left) to 1 (right).</summary>
<returns>a <see cref="T:System.Single" /></returns>
<remarks>Reversed for RTL layouts.
<para>
Allowed values: [0,1]
</para><para>
Default value: 0
</para></remarks>
</Docs>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public float Alignment { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The alignment for the contents of the entry</summary>
<returns>a <see cref="T:System.Single" /></returns>
<remarks>This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
<para>
The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts
</para></remarks>
</Docs>
</Member>
<Member MemberName="Completion">
<MemberSignature Language="C#" Value="public Gtk.EntryCompletion Completion { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.EntryCompletion</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The auxiliary completion object</summary>
<returns>a <see cref="T:Gtk.EntryCompletion" /></returns>
<remarks>All further configuration of the completion mechanism is done on completion using the <see cref="T:Gtk.EntryCompletion" /> API.</remarks>
</Docs>
</Member>
<Member MemberName="PrependText">
<MemberSignature Language="C#" Value="public void PrependText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Prepends the given text to the contents of the widget.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="AppendText">
<MemberSignature Language="C#" Value="public void AppendText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Appends the given text to the contents of the widget.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Entry (int max);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="max" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.Entry" /> with the given maximum length.</summary>
<param name="max">a <see cref="T:System.Int32" />, the maximum length of the entry, or 0 for no maximum.</param>
<returns>a <see cref="T:Gtk.Entry" /></returns>
<remarks>
<block subset="none" type="note">
<para>the existence of this function is inconsistent with the rest of the Gtk API. The normal setup would be to just require the user to make an extra call to <see cref="P:Gtk.Entry.MaxLength" /> instead. It is not expected that this function will be removed, but it would be better practice not to use it.
</para>
</block>
</remarks>
</Docs>
</Member>
<Member MemberName="InvisibleChar">
<MemberSignature Language="C#" Value="public char InvisibleChar { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The character to display when <see cref="P:Gtk.Entry.Visibility" /> is <see langword="false" /></summary>
<returns>a <see cref="T:System.Char" /></returns>
<remarks>The is the character displayed in the entry in place of the actual characters of <see cref="P:Gtk.Entry.Text" /> when <see cref="P:Gtk.Entry.Visibility" /> is <see langword="false" />. The default invisible character is an asterisk ('*'). If you set this to 0, then no characters will be displayed at all.</remarks>
</Docs>
</Member>
<Member MemberName="Backspace">
<MemberSignature Language="C#" Value="public event EventHandler Backspace;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="OnBackspace">
<MemberSignature Language="C#" Value="protected virtual void OnBackspace ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Entry.Backspace" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Entry.Backspace" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="LayoutIndexToTextIndex">
<MemberSignature Language="C#" Value="public int LayoutIndexToTextIndex (int layout_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="layout_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="layout_index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextIndexToLayoutIndex">
<MemberSignature Language="C#" Value="public int TextIndexToLayoutIndex (int text_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text_index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
Reference in a new issue View git blame Copy permalink