From 7059fb503eda343d8af009b8393da1d41a588b2d Mon Sep 17 00:00:00 2001 From: Stephane Delcroix Date: Thu, 8 Jan 2009 15:28:27 +0000 Subject: [PATCH] doc for Ask[Password|Question][Args|Flags|Handler], MountOperation, PasswordSave, Reply[Args|Handler] svn path=/trunk/gtk-sharp/; revision=122780 --- doc/en/GLib/AskPasswordArgs.xml | 24 +++++----- doc/en/GLib/AskPasswordFlags.xml | 15 ++++--- doc/en/GLib/AskPasswordHandler.xml | 6 +-- doc/en/GLib/AskQuestionArgs.xml | 14 +++--- doc/en/GLib/AskQuestionHandler.xml | 6 +-- doc/en/GLib/MountOperation.xml | 72 +++++++++++++++++------------- doc/en/GLib/PasswordSave.xml | 13 +++--- doc/en/GLib/ReplyArgs.xml | 12 ++--- doc/en/GLib/ReplyHandler.xml | 6 +-- 9 files changed, 92 insertions(+), 76 deletions(-) diff --git a/doc/en/GLib/AskPasswordArgs.xml b/doc/en/GLib/AskPasswordArgs.xml index c23a48394..fd68a86c4 100644 --- a/doc/en/GLib/AskPasswordArgs.xml +++ b/doc/en/GLib/AskPasswordArgs.xml @@ -8,8 +8,8 @@ - To be added. - To be added. + Event data. + The event invokes delegate which pass event data via this class. @@ -18,7 +18,7 @@ Constructor - To be added. + Public constructor. To be added. @@ -30,8 +30,8 @@ System.String - To be added. - To be added. + The default domain. + A containing the default domain. To be added. @@ -43,8 +43,8 @@ System.String - To be added. - To be added. + The default user name. + A containing the default user name. To be added. @@ -56,8 +56,8 @@ GLib.AskPasswordFlags - To be added. - To be added. + A set of . + A set of . To be added. @@ -69,11 +69,11 @@ System.String - To be added. - To be added. + A message to display to the user. + A containing a message to display to the user. To be added. - + \ No newline at end of file diff --git a/doc/en/GLib/AskPasswordFlags.xml b/doc/en/GLib/AskPasswordFlags.xml index 3bad6ad78..6ebfff875 100644 --- a/doc/en/GLib/AskPasswordFlags.xml +++ b/doc/en/GLib/AskPasswordFlags.xml @@ -15,7 +15,8 @@ - To be added. + + are used to request specific information from the user, or to notify the user of their choices in an authentication situation. To be added. @@ -27,7 +28,7 @@ GLib.AskPasswordFlags - To be added. + Operation supports anonymous users. @@ -38,7 +39,7 @@ GLib.AskPasswordFlags - To be added. + Operation requires a domain. @@ -49,7 +50,7 @@ GLib.AskPasswordFlags - To be added. + Operation requires a password. @@ -60,7 +61,7 @@ GLib.AskPasswordFlags - To be added. + Operation requires a username. @@ -71,9 +72,9 @@ GLib.AskPasswordFlags - To be added. + Operation requires a username. - + \ No newline at end of file diff --git a/doc/en/GLib/AskPasswordHandler.xml b/doc/en/GLib/AskPasswordHandler.xml index 99b6f3e9f..b4e6e7b67 100644 --- a/doc/en/GLib/AskPasswordHandler.xml +++ b/doc/en/GLib/AskPasswordHandler.xml @@ -16,8 +16,8 @@ To be added. To be added. - To be added. - To be added. + Event handler. + The event uses this delegate. - + \ No newline at end of file diff --git a/doc/en/GLib/AskQuestionArgs.xml b/doc/en/GLib/AskQuestionArgs.xml index 5af57d658..f7939c59d 100644 --- a/doc/en/GLib/AskQuestionArgs.xml +++ b/doc/en/GLib/AskQuestionArgs.xml @@ -8,8 +8,8 @@ - To be added. - To be added. + Event data. + The event invokes delegates which pass event data via this class. @@ -30,8 +30,8 @@ System.String[] - To be added. - To be added. + Possible choices. + An array of strings for each possible choice. To be added. @@ -43,11 +43,11 @@ System.String - To be added. - To be added. + A message to display to the user. + A string containing a message to display to the user. To be added. - + \ No newline at end of file diff --git a/doc/en/GLib/AskQuestionHandler.xml b/doc/en/GLib/AskQuestionHandler.xml index 36b683eb9..cbacdb0e1 100644 --- a/doc/en/GLib/AskQuestionHandler.xml +++ b/doc/en/GLib/AskQuestionHandler.xml @@ -16,8 +16,8 @@ To be added. To be added. - To be added. - To be added. + Event handler. + See . - + \ No newline at end of file diff --git a/doc/en/GLib/MountOperation.xml b/doc/en/GLib/MountOperation.xml index f810a55e3..683ecdaf9 100644 --- a/doc/en/GLib/MountOperation.xml +++ b/doc/en/GLib/MountOperation.xml @@ -8,8 +8,14 @@ - To be added. - To be added. + + : Authentication methods for mountable locations. + + + provides a mechanism for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. + Mounting operations are handed a 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. + Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as . + @@ -18,8 +24,8 @@ Constructor - To be added. - To be added. + Creates a new mount operation. + This is not normally used, instead you instantiate a subclass of this, such as . @@ -66,9 +72,9 @@ System.Boolean - To be added. + Wether to use an anonymous user when authenticating. To be added. - To be added. + Default to False. @@ -84,7 +90,9 @@ GLib.AskPasswordHandler - To be added. + Emitted when a mount operation asks the user for a password. + + To be added. @@ -101,7 +109,7 @@ GLib.AskQuestionHandler - To be added. + Emitted when asking the user a question and gives a list of choices for the user to choose from. To be added. @@ -118,9 +126,13 @@ System.Int32 - To be added. - To be added. - To be added. + The index of the user's choice when a question is asked. + The index of the user's choice when a question is asked during the mount operation. + + Allowed values: >= 0 + Default value: 0 + See also . + @@ -136,9 +148,9 @@ System.String - To be added. - To be added. - To be added. + The domain to use for the mount operation. + The domain to use for the mount operation. + Default value: null. @@ -152,8 +164,8 @@ - To be added. - To be added. + A + Emits the signal. To be added. @@ -193,7 +205,7 @@ To be added. To be added. To be added. - To be added. + Default handler for the event. To be added. @@ -216,7 +228,7 @@ To be added. To be added. - To be added. + Default handler for the event. To be added. @@ -237,7 +249,7 @@ To be added. - To be added. + Default handler for the event. To be added. @@ -254,9 +266,9 @@ System.String - To be added. - To be added. - To be added. + The password that is used for authentication + The password that is used for authentication when carrying out the mount operation. + Default value: null. @@ -272,9 +284,9 @@ GLib.PasswordSave - To be added. - To be added. - To be added. + Ff and how the password information should be saved. + Determines if and how the password information should be saved. + Default value: @@ -290,7 +302,7 @@ GLib.ReplyHandler - To be added. + Emitted when the user has replied to the mount operation. To be added. @@ -307,11 +319,11 @@ System.String - To be added. - To be added. - To be added. + The user name that is used for authentication. + The user name that is used for authentication when carrying out the mount operation. + Default value: null. - + \ No newline at end of file diff --git a/doc/en/GLib/PasswordSave.xml b/doc/en/GLib/PasswordSave.xml index c3cf8cc51..361041439 100644 --- a/doc/en/GLib/PasswordSave.xml +++ b/doc/en/GLib/PasswordSave.xml @@ -12,8 +12,9 @@ - To be added. - To be added. + + is used to indicate the lifespan of a saved password. + Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there. @@ -24,7 +25,7 @@ GLib.PasswordSave - To be added. + Save a password for the session. @@ -35,7 +36,7 @@ GLib.PasswordSave - To be added. + Never save a password. @@ -46,9 +47,9 @@ GLib.PasswordSave - To be added. + Save a password permanently. - + \ No newline at end of file diff --git a/doc/en/GLib/ReplyArgs.xml b/doc/en/GLib/ReplyArgs.xml index e4014068a..389a159b5 100644 --- a/doc/en/GLib/ReplyArgs.xml +++ b/doc/en/GLib/ReplyArgs.xml @@ -8,8 +8,10 @@ - To be added. - To be added. + Event data. + + The event invokes delegates which pass event data via this class. + @@ -30,11 +32,11 @@ GLib.MountOperationResult - To be added. - To be added. + How the request was handled . + A indicating how the request was handled. To be added. - + \ No newline at end of file diff --git a/doc/en/GLib/ReplyHandler.xml b/doc/en/GLib/ReplyHandler.xml index 27ff01276..756ce3c45 100644 --- a/doc/en/GLib/ReplyHandler.xml +++ b/doc/en/GLib/ReplyHandler.xml @@ -16,8 +16,8 @@ To be added. To be added. - To be added. - To be added. + Event handler. + See . - + \ No newline at end of file