ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc for Ask[Password|Question][Args|Flags|Handler], MountOperation, PasswordSave, Reply[Args|Handler]

Browse source 
svn path=/trunk/gtk-sharp/; revision=122780
This commit is contained in:
Stephane Delcroix 2009-01-08 15:28:27 +00:00
parent f559a7b31a
commit 7059fb503e
9 changed files with 92 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/en/GLib/AskPasswordArgs.xml
View file

@ -8,8 +8,8 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event data.</summary>
<remarks>The <see cref="M:GLib.MountOperation.AskPassword" /> event invokes <see cref="T:GLib.AskPasswordHandler" /> delegate which pass event data via this class.</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
@ -18,7 +18,7 @@
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Public constructor.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -30,8 +30,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>The default domain.</summary>
<value>A <see cref="T:System.String" /> containing the default domain.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -43,8 +43,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>The default user name.</summary>
<value>A <see cref="T:System.String" /> containing the default user name.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -56,8 +56,8 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>A set of <see cref="T:GLib.AskPasswordFlags" />.</summary>
<value>A set of <see cref="T:GLib.AskPasswordFlags" />.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -69,11 +69,11 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>A message to display to the user. </summary>
<value>A <see cref="T:System.String" /> containing a message to display to the user. </value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>
</Type>

15
doc/en/GLib/AskPasswordFlags.xml
View file

@ -15,7 +15,8 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>
<see cref="T:GLib.AskPasswordFlags" /> are used to request specific information from the user, or to notify the user of their choices in an authentication situation.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -27,7 +28,7 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Operation supports anonymous users.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -38,7 +39,7 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Operation requires a domain.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -49,7 +50,7 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Operation requires a password. </summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -60,7 +61,7 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Operation requires a username. </summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -71,9 +72,9 @@
<ReturnType>GLib.AskPasswordFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Operation requires a username.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/GLib/AskPasswordHandler.xml
View file

@ -16,8 +16,8 @@
<Docs>
<param name="o">To be added.</param>
<param name="args">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event handler.</summary>
<remarks>The <see cref="E:GLib.MountOperation.AskPassword" /> event uses this delegate.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Type>
</Type>

14
doc/en/GLib/AskQuestionArgs.xml
View file

@ -8,8 +8,8 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event data.</summary>
<remarks>The <see cref="M:GLib.MountOperation.AskQuestion" /> event invokes <see cref="T:GLib.AskQuestionHandler" /> delegates which pass event data via this class.</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
@ -30,8 +30,8 @@
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Possible choices.</summary>
<value>An array of strings for each possible choice. </value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -43,11 +43,11 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>A message to display to the user. </summary>
<value>A string containing a message to display to the user. </value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/GLib/AskQuestionHandler.xml
View file

@ -16,8 +16,8 @@
<Docs>
<param name="o">To be added.</param>
<param name="args">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event handler.</summary>
<remarks>See <see cref="M:GLib.MountOperation.AskQuestion" />.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Type>
</Type>

72
doc/en/GLib/MountOperation.xml
View file

@ -8,8 +8,14 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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>
@ -18,8 +24,8 @@
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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>
@ -66,9 +72,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Wether to use an anonymous user when authenticating.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>Default to False.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -84,7 +90,9 @@
<ReturnType>GLib.AskPasswordHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Emitted when a mount operation asks the user for a password.
</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -101,7 +109,7 @@
<ReturnType>GLib.AskQuestionHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<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>
@ -118,9 +126,13 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<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>
@ -136,9 +148,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<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>
@ -152,8 +164,8 @@
<Parameter Name="result" Type="GLib.MountOperationResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<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>
@ -193,7 +205,7 @@
<param name="default_user">To be added.</param>
<param name="default_domain">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<summary>Default handler for the <see cref="M:GLib.MountOperation.AskPassword" /> event.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -216,7 +228,7 @@
<Docs>
<param name="message">To be added.</param>
<param name="choices">To be added.</param>
<summary>To be added.</summary>
<summary>Default handler for the <see cref="M:GLib.MountOperation.AskQuestion" /> event.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -237,7 +249,7 @@
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<summary>Default handler for the <see cref="M:GLib.MountOperation.Reply" /> event.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -254,9 +266,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<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>
@ -272,9 +284,9 @@
<ReturnType>GLib.PasswordSave</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<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>
@ -290,7 +302,7 @@
<ReturnType>GLib.ReplyHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Emitted when the user has replied to the mount operation.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
@ -307,11 +319,11 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<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>
</Type>

13
doc/en/GLib/PasswordSave.xml
View file

@ -12,8 +12,9 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
<see cref="T:GLib.PasswordSave" /> is used to indicate the lifespan of a saved password.</summary>
<remarks>Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there.</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
@ -24,7 +25,7 @@
<ReturnType>GLib.PasswordSave</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Save a password for the session.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -35,7 +36,7 @@
<ReturnType>GLib.PasswordSave</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Never save a password.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
@ -46,9 +47,9 @@
<ReturnType>GLib.PasswordSave</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Save a password permanently.</summary>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>
</Type>

12
doc/en/GLib/ReplyArgs.xml
View file

@ -8,8 +8,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event data.</summary>
<remarks>
<para>The <see cref="M:GLib.MountOperation.Reply" /> event invokes <see cref="T:GLib.ReplyHandler" /> delegates which pass event data via this class.</para>
</remarks>
<since version="Gtk# 2.14" />
</Docs>
<Members>
@ -30,11 +32,11 @@
<ReturnType>GLib.MountOperationResult</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>How the request was handled .</summary>
<value>A <see cref="T:GLib.MountOperationResult" /> indicating how the request was handled.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/GLib/ReplyHandler.xml
View file

@ -16,8 +16,8 @@
<Docs>
<param name="o">To be added.</param>
<param name="args">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Event handler.</summary>
<remarks>See <see cref="M:GLib.MountOperation.Reply" />.</remarks>
<since version="Gtk# 2.14" />
</Docs>
</Type>
</Type>