GtkSharp/Source/doc/en/GLib/MountOperation.xml

<Type Name="MountOperation" FullName="GLib.MountOperation">
  <TypeSignature Language="C#" Value="public class MountOperation : GLib.Object" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MountOperation extends GLib.Object" />
  <AssemblyInfo>
    <AssemblyName>gio-sharp</AssemblyName>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>GLib.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
      <see cref="T:GLib.MountOperation" />: Authentication methods for mountable locations.</summary>
    <remarks>
      <para>
        <see cref="T:GLib.MountOperation" /> provides a mechanism for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations.</para>
      <para>Mounting operations are handed a <see cref="T:GLib.MountOperation" /> that then can use if they require any privileges or authentication for their volumes to be mounted (e.g. a hard disk partition or an encrypted filesystem), or if they are implementing a remote server protocol which requires user credentials such as FTP or WebDAV.</para>
      <para>Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as <see cref="T:Gtk.MountOperation" />.</para>
    </remarks>
    <since version="Gtk# 2.14" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MountOperation ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <summary>Creates a new mount operation.</summary>
        <remarks>This is not normally used, instead you instantiate a subclass of this, such as <see cref="T:Gtk.MountOperation" />.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MountOperation (IntPtr raw);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="raw">Native object pointer.</param>
        <summary>Internal constructor</summary>
        <remarks>This is not typically used by C# code.  Exposed primarily for use by language bindings to wrap native object instances.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="Aborted">
      <MemberSignature Language="C#" Value="public event EventHandler Aborted;" />
      <MemberSignature Language="ILAsm" Value=".event class System.EventHandler Aborted" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("aborted")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="Anonymous">
      <MemberSignature Language="C#" Value="public bool Anonymous { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool Anonymous" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("anonymous")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Wether to use an anonymous user when authenticating.</summary>
        <value>To be added.</value>
        <remarks>Default to False.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="AskPassword">
      <MemberSignature Language="C#" Value="public event GLib.AskPasswordHandler AskPassword;" />
      <MemberSignature Language="ILAsm" Value=".event class GLib.AskPasswordHandler AskPassword" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("ask-password")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>GLib.AskPasswordHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Emitted when a mount operation asks the user for a password.

</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="AskQuestion">
      <MemberSignature Language="C#" Value="public event GLib.AskQuestionHandler AskQuestion;" />
      <MemberSignature Language="ILAsm" Value=".event class GLib.AskQuestionHandler AskQuestion" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("ask-question")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>GLib.AskQuestionHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Emitted when asking the user a question and gives a list of choices for the user to choose from.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="Choice">
      <MemberSignature Language="C#" Value="public int Choice { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Choice" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("choice")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The index of the user's choice when a question is asked.</summary>
        <value>The index of the user's choice when a question is asked during the mount operation.</value>
        <remarks>
          <para>Allowed values: &gt;= 0</para>
          <para> Default value: 0</para>
          <para>See also <see cref="E:GLib.MountOperation.AskQuestion" />.</para>
        </remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="Domain">
      <MemberSignature Language="C#" Value="public string Domain { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Domain" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("domain")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The domain to use for the mount operation.</summary>
        <value>The domain to use for the mount operation.</value>
        <remarks>Default value: null.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="EmitReply">
      <MemberSignature Language="C#" Value="public void EmitReply (GLib.MountOperationResult result);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EmitReply(valuetype GLib.MountOperationResult result) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="result" Type="GLib.MountOperationResult" />
      </Parameters>
      <Docs>
        <param name="result">A <see cref="T:GLib.MountOperationResult" /></param>
        <summary>Emits the <see cref="M:GLib.MountOperation.Reply" /> signal.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>GType Property.</summary>
        <value>The native <see cref="T:GLib.GType" /> value.</value>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:GLib.MountOperation" />.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="OnAborted">
      <MemberSignature Language="C#" Value="protected virtual void OnAborted ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnAborted() cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideAborted", Type=typeof(GLib.MountOperation))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Default handler for the <see cref="M:GLib.MountOperation.Aborted" /> event.</summary>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:GLib.MountOperation.Aborted" /> event.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="OnAskPassword">
      <MemberSignature Language="C#" Value="protected virtual void OnAskPassword (string message, string default_user, string default_domain, GLib.AskPasswordFlags flags);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnAskPassword(string message, string default_user, string default_domain, valuetype GLib.AskPasswordFlags flags) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideAskPassword", Type=typeof(GLib.MountOperation))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="default_user" Type="System.String" />
        <Parameter Name="default_domain" Type="System.String" />
        <Parameter Name="flags" Type="GLib.AskPasswordFlags" />
      </Parameters>
      <Docs>
        <param name="message">To be added.</param>
        <param name="default_user">To be added.</param>
        <param name="default_domain">To be added.</param>
        <param name="flags">To be added.</param>
        <summary>Default handler for the <see cref="M:GLib.MountOperation.AskPassword" /> event.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="OnAskQuestion">
      <MemberSignature Language="C#" Value="protected virtual void OnAskQuestion (string message, string[] choices);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnAskQuestion(string message, string[] choices) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideAskQuestion", Type=typeof(GLib.MountOperation))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="choices" Type="System.String[]" />
      </Parameters>
      <Docs>
        <param name="message">To be added.</param>
        <param name="choices">To be added.</param>
        <summary>Default handler for the <see cref="M:GLib.MountOperation.AskQuestion" /> event.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="OnReply">
      <MemberSignature Language="C#" Value="protected virtual void OnReply (GLib.MountOperationResult result);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnReply(valuetype GLib.MountOperationResult result) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideReply", Type=typeof(GLib.MountOperation))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="result" Type="GLib.MountOperationResult" />
      </Parameters>
      <Docs>
        <param name="result">To be added.</param>
        <summary>Default handler for the <see cref="M:GLib.MountOperation.Reply" /> event.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="OnShowProcesses">
      <MemberSignature Language="C#" Value="protected virtual void OnShowProcesses (string message, IntPtr processes, string[] choices);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnShowProcesses(string message, native int processes, string[] choices) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideShowProcesses", Type=typeof(GLib.MountOperation))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="processes" Type="System.IntPtr" />
        <Parameter Name="choices" Type="System.String[]" />
      </Parameters>
      <Docs>
        <param name="message">To be added.</param>
        <param name="processes">To be added.</param>
        <param name="choices">To be added.</param>
        <summary>Default handler for the <see cref="M:GLib.MountOperation.ShowProcesses" /> event.</summary>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:GLib.MountOperation.ShowProcesses" /> event.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="Password">
      <MemberSignature Language="C#" Value="public string Password { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Password" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("password")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The password that is used for authentication</summary>
        <value>The password that is used for authentication when carrying out the mount operation.</value>
        <remarks>Default value: null.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="PasswordSave">
      <MemberSignature Language="C#" Value="public GLib.PasswordSave PasswordSave { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype GLib.PasswordSave PasswordSave" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("password-save")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>GLib.PasswordSave</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Ff and how the password information should be saved.</summary>
        <value>Determines if and how the password information should be saved.</value>
        <remarks>Default value: <see cref="M:GLib.PasswordSave.Never" /></remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="Reply">
      <MemberSignature Language="C#" Value="public event GLib.ReplyHandler Reply;" />
      <MemberSignature Language="ILAsm" Value=".event class GLib.ReplyHandler Reply" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("reply")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>GLib.ReplyHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Emitted when the user has replied to the mount operation.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
    <Member MemberName="ShowProcesses">
      <MemberSignature Language="C#" Value="public event GLib.ShowProcessesHandler ShowProcesses;" />
      <MemberSignature Language="ILAsm" Value=".event class GLib.ShowProcessesHandler ShowProcesses" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("show-processes")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>GLib.ShowProcessesHandler</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="Username">
      <MemberSignature Language="C#" Value="public string Username { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Username" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("username")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The user name that is used for authentication.</summary>
        <value>The user name that is used for authentication when carrying out the mount operation.</value>
        <remarks>Default value: null.</remarks>
        <since version="Gtk# 2.14" />
      </Docs>
    </Member>
  </Members>
</Type>