GtkSharp/doc/en/Gnome/FileEntry.xml
Duncan Mak f3966a2a4c 2003-02-23 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: a Big patch. This adds code-generated documentation
	for internal constructors, the GType property and the Finalized method.

svn path=/trunk/gtk-sharp/; revision=11858
2003-02-23 07:26:30 +00:00

510 lines
No EOL
19 KiB
XML

<Type Name="FileEntry" FullName="Gnome.FileEntry">
<TypeSignature Language="C#" Value="public class FileEntry : Gtk.VBox, Editable, IWrapper, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.VBox</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>To be added</summary>
<param name="start">To be added: an object of type 'int'</param>
<param name="end">To be added: an object of type 'int'</param>
<remarks>To be added</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>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</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>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<remarks>To be added</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>To be added</summary>
<remarks>To be added</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;" />
<Parameter Name="end" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start">To be added: an object of type 'int&amp;'</param>
<param name="end">To be added: an object of type 'int&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</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="InsertText">
<MemberSignature Language="C#" Value="public virtual void InsertText (string new_text, int new_text_length, ref int position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_text" Type="System.String" />
<Parameter Name="new_text_length" Type="System.Int32" />
<Parameter Name="position" Type="System.Int32&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
<param name="new_text_length">To be added: an object of type 'int'</param>
<param name="position">To be added: an object of type 'int&amp;'</param>
<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="Construct">
<MemberSignature Language="C#" Value="public void Construct (string history_id, string browse_dialog_title);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="history_id" Type="System.String" />
<Parameter Name="browse_dialog_title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="history_id">To be added: an object of type 'string'</param>
<param name="browse_dialog_title">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetFullPath">
<MemberSignature Language="C#" Value="public string GetFullPath (bool file_must_exist);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_must_exist" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_must_exist">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual 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="protected FileEntry (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of FileEntry, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.FileEntry" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileEntry (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 FileEntry, 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 FileEntry (string history_id, string browse_dialog_title);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="history_id" Type="System.String" />
<Parameter Name="browse_dialog_title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="history_id">To be added: an object of type 'string'</param>
<param name="browse_dialog_title">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gnome.FileEntry'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FileEntry ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.FileEntry'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.FileEntry</summary>
<returns>The GLib TYpe for the Gnome.FileEntry class.</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>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</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>To be added</summary>
<returns>To be added: an object of type 'Gtk.Entry'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Modal">
<MemberSignature Language="C#" Value="public bool Modal { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DefaultPath">
<MemberSignature Language="C#" Value="public string DefaultPath { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Filename">
<MemberSignature Language="C#" Value="public string Filename { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BrowseDialogTitle">
<MemberSignature Language="C#" Value="public string BrowseDialogTitle { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DirectoryEntry">
<MemberSignature Language="C#" Value="public bool DirectoryEntry { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GnomeEntry">
<MemberSignature Language="C#" Value="public Gnome.Entry GnomeEntry { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Entry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.Entry'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextInserted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.TextInsertedHandler TextInserted;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextDeleted">
<MemberSignature Language="C#" Value="public virtual event GtkSharp.TextDeletedHandler TextDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public virtual event EventHandler Changed;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BrowseClicked">
<MemberSignature Language="C#" Value="public event EventHandler BrowseClicked;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Activated">
<MemberSignature Language="C#" Value="public event EventHandler Activated;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>