Ryujinx-GtkSharp/doc/en/Gnome/FileEntry.xml
Mike Kestner f0c0542224 revert the last patch from shane that caused large diffs rerunning the updater
svn path=/trunk/gtk-sharp/; revision=38506
2005-01-07 20:55:53 +00:00

627 lines
25 KiB
XML

<Type Name="FileEntry" FullName="Gnome.FileEntry">
<TypeSignature Language="C#" Value="public class FileEntry : Gtk.VBox, Editable, IWrapper, Implementor, IDisposable" Maintainer="John Luke" />
<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 widget for selecting a file or directory.</summary>
<remarks>A <see cref="T:Gnome.FileEntry" /> contains a <see cref="T:Gnome.Entry" /> and a browse dialog.</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>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 of the <see cref="T:Gtk.Entry" /> between <paramref name="start" /> and <paramref name="end" />.</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 of the <see cref="T:Gtk.Entry" /> 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>Deletes the text of the <see cref="T:Gtk.Entry" /> 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>
</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>
</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>To be added</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>
</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>
</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>Construct a <see cref="T:Gnome.FileEntry" />.</summary>
<param name="history_id">an object of type <see cref="T:System.String" /></param>
<param name="browse_dialog_title">an object of type <see cref="T:System.String" /></param>
<remarks>
</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>Gets the full absolute path of the file from the entry.</summary>
<param name="file_must_exist">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>If <paramref name="file_must_exist" /> is <see langword="false" />, nothing is tested and the path is returned. If <paramref name="file_must_exist" /> is <see langword="true" />, then the path is only returned if the path actually exists. In case the entry is a directory entry (see <see cref="P:Gnome.FileEntry.DirectoryEntry" />), then if the path exists and is a directory then it is returned; if not, it is assumed it was a file so we try to strip it, and try again. It allocates memory for the returned string.</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 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>Creates a new <see cref="T:Gnome.FileEntry" />.</summary>
<param name="history_id">an object of type <see cref="T:System.String" /></param>
<param name="browse_dialog_title">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:Gnome.FileEntry" /></returns>
<remarks>
</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="Gtk.Entry" /> should be 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 cursor position in the <see cref="T:Gtk.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="Title">
<MemberSignature Language="C#" Value="public string Title { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Set the title of the browse dialog.</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>The new title will go into effect the next time the browse button is pressed.
</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 associated <see cref="T:Gtk.Entry" />.</summary>
<returns>an object of type <see cref="T:Gtk.Entry" /></returns>
<remarks>
</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>
</Parameters>
<Docs>
<summary>Whether the browse dialog is modal.</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="DefaultPath">
<MemberSignature Language="C#" Value="public string DefaultPath { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Set the default path of browse dialog.</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>The default path is only used if the entry is empty or if the current path of the entry is not an absolute path, in which case the default path is prepended to it before the dialog is started.
</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>
</Parameters>
<Docs>
<summary>The value of the internal <see cref="T:Gnome.Entry" />.</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="BrowseDialogTitle">
<MemberSignature Language="C#" Value="public string BrowseDialogTitle { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Title of the browse dialog.</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="DirectoryEntry">
<MemberSignature Language="C#" Value="public bool DirectoryEntry { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Whether this is a directory only entry.</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>If <see langword="true" />, then <see cref="M:Gnome.FileEntry.GetFullPath(System.Boolean)" /> will check for the file being a directory, and the browse dialog will have the file list disabled.
</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 ID for the associated history.</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="GnomeEntry">
<MemberSignature Language="C#" Value="public Gnome.Entry GnomeEntry { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gnome.Entry</ReturnType>
</ReturnValue>
<Docs>
<summary>The associated <see cref="T:Gnome.Entry" />.</summary>
<returns>an object of type <see cref="T:Gnome.Entry" /></returns>
<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 into the <see cref="T:Gtk.Entry" />.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="BrowseClicked">
<MemberSignature Language="C#" Value="public event EventHandler BrowseClicked;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when the browse button is clicked.</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:Gtk.Entry" /> is activated.</summary>
<remarks>
</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>Inserts into the <see cref="T:Gtk.Entry" /><paramref name="new_text" /> at <paramref name="position" />.</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>
</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:Gnome.FileEntry" />.</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:Gnome.FileEntry.Activated" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.FileEntry.Activated" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="OnBrowseClicked">
<MemberSignature Language="C#" Value="protected virtual void OnBrowseClicked ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gnome.FileEntry.BrowseClicked" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.FileEntry.BrowseClicked" /> 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:Gnome.FileEntry.Changed" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gnome.FileEntry.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:Gnome.FileEntry.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:Gnome.FileEntry.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:Gnome.FileEntry.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:Gnome.FileEntry.TextInserted" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FileEntry (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:Gnome.FileEntry" /></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="TextDeleted">
<MemberSignature Language="C#" Value="public virtual event Gtk.TextDeletedHandler TextDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.TextDeletedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when text is deleted into the <see cref="T:Gtk.Entry" />.</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>Emitted when text is inserted into the <see cref="T:Gtk.Entry" />.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="UseFilechooser">
<MemberSignature Language="C#" Value="public bool UseFilechooser { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FilechooserAction">
<MemberSignature Language="C#" Value="public Gtk.FileChooserAction FilechooserAction { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileChooserAction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.FileChooserAction" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Directory">
<MemberSignature Language="C#" Value="public bool Directory { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>