2003-08-09 John Luke <jluke@cfl.rr.com>

* en/Gtk/Entry.xml: add example

svn path=/trunk/gtk-sharp/; revision=17210
This commit is contained in:
John Luke 2003-08-10 02:49:38 +00:00
parent 64b0c972b6
commit d4baf8e789
2 changed files with 146 additions and 61 deletions

View File

@ -1,3 +1,7 @@
2003-08-09 John Luke <jluke@cfl.rr.com>
* en/Gtk/Entry.xml: add example
2003-08-06 John Luke <jluke@cfl.rr.com>
* en/Gtk/Notebook.xml: add example, see references

View File

@ -14,6 +14,68 @@
See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing large amounts of text.
</para>
</remarks>
<example>
<code language="C#">
using System;
using Gtk;
using GtkSharp;
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>
</Docs>
<Base>
<BaseTypeName>Gtk.Widget</BaseTypeName>
@ -50,8 +112,8 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_text" Type="System.String" />
</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>
@ -70,8 +132,8 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>Specific implementation of Gtk.CellEditable.StartEditing for the Entry widget.</summary>
<param name="evnt" />
@ -109,9 +171,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start" Type="System.Int32" />
<Parameter Name="end" Type="System.Int32" />
</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" />
@ -128,9 +190,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start_pos" Type="System.Int32" />
<Parameter Name="end_pos" Type="System.Int32" />
</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>
@ -148,9 +210,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start_pos" Type="System.Int32" />
<Parameter Name="end_pos" Type="System.Int32" />
</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" />
@ -189,9 +251,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<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>
<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>
@ -234,9 +296,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</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>
@ -264,8 +326,8 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -304,8 +366,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -321,8 +382,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>The position of the cursor.</summary>
<param name="value">the new cursor position, in characters.</param>
@ -356,8 +416,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -375,8 +434,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -424,8 +482,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -453,8 +510,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -472,8 +528,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>Whether or not this Entry is editable.</summary>
<param name="value">
@ -495,8 +550,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<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>
@ -517,8 +571,7 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>Whether or not this Entry should be surrounded by a 3D frame.</summary>
<param name="value">
@ -533,7 +586,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="WidgetRemoved">
<MemberSignature Language="C#" Value="public virtual event EventHandler WidgetRemoved;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<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>
@ -543,7 +598,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="EditingDone">
<MemberSignature Language="C#" Value="public virtual event EventHandler EditingDone;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implements the EditingDone method of the <see cref="T:Gtk.CellEditable" /> interface.</summary>
@ -553,7 +610,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="TextInserted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.TextInsertedHandler TextInserted;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.TextInsertedHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.TextInsertedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when text is inserted into the Entry.</summary>
@ -563,7 +622,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="TextDeleted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.TextDeletedHandler TextDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.TextDeletedHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.TextDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when text is deleted from the Entry.</summary>
@ -573,7 +634,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public virtual event EventHandler Changed;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When the contents of the Entry change, this event is fired.</summary>
@ -583,7 +646,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="MoveCursor">
<MemberSignature Language="C#" Value="public event GtkSharp.MoveCursorHandler MoveCursor;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.MoveCursorHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.MoveCursorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event handler to be notified when the cursor of an Entry moves.</summary>
@ -593,7 +658,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="ClipboardCut">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardCut;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<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>
@ -603,7 +670,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="Activated">
<MemberSignature Language="C#" Value="public event EventHandler Activated;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to be notified when the user hits 'return'.</summary>
@ -615,7 +684,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="DeleteFromCursor">
<MemberSignature Language="C#" Value="public event GtkSharp.DeleteFromCursorHandler DeleteFromCursor;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.DeleteFromCursorHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.DeleteFromCursorHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Connect to this event to find out when text is deleted from the Entry by the user.</summary>
@ -627,7 +698,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="ClipboardPasted">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardPasted;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<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>
@ -639,7 +712,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="ClipboardCopied">
<MemberSignature Language="C#" Value="public event EventHandler ClipboardCopied;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<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>
@ -651,7 +726,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="PopulatePopup">
<MemberSignature Language="C#" Value="public event GtkSharp.PopulatePopupHandler PopulatePopup;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.PopulatePopupHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.PopulatePopupHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
@ -663,7 +740,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="ToggleOverwrite">
<MemberSignature Language="C#" Value="public event EventHandler ToggleOverwrite;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue>
<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>
@ -675,7 +754,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<Member MemberName="InsertAtCursor">
<MemberSignature Language="C#" Value="public event GtkSharp.InsertAtCursorHandler InsertAtCursor;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.InsertAtCursorHandler</ReturnType></ReturnValue>
<ReturnValue>
<ReturnType>GtkSharp.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>
@ -691,9 +772,9 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_text" Type="System.String" />
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Parameter Name="new_text" Type="System.String" />
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
@ -706,8 +787,8 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -722,8 +803,8 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="initialText" Type="System.String" />
</Parameters>
<Parameter Name="initialText" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="initialText">To be added: an object of type 'string'</param>
@ -732,4 +813,4 @@ See also the <see cref="T:Gtk.TextView" /> widget for displaying and editing lar
</Docs>
</Member>
</Members>
</Type>
</Type>