From 145109c3a04f03ba0c9dcbf130f223167a3044f6 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Sun, 27 Jun 2004 01:39:53 +0000 Subject: [PATCH] Changes from Erik Dasque svn path=/trunk/gtk-sharp/; revision=30453 --- doc/en/GConf/ChangeSet.xml | 12 ++++++------ doc/en/GConf/NoSuchKeyException.xml | 4 ++-- doc/en/GConf/NotifyEventArgs.xml | 17 +++++++++-------- doc/en/GConf/NotifyEventHandler.xml | 9 +++++++-- 4 files changed, 24 insertions(+), 18 deletions(-) diff --git a/doc/en/GConf/ChangeSet.xml b/doc/en/GConf/ChangeSet.xml index 4f30b766b..478805782 100644 --- a/doc/en/GConf/ChangeSet.xml +++ b/doc/en/GConf/ChangeSet.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added - To be added + A ChangeSet is a set of changes to the GConf database that can be commited and reversed easily. + The changes can be both set and unset operations. Currently the ChangeSet operations are not atomic, and not specially optimized for. However, it is suitable for use, for instance, preferences dialogs. GConf.ClientBase @@ -31,8 +31,8 @@ - To be added - To be added + Disposes the resources associated with the object + Called by Finalize @@ -41,8 +41,8 @@ - To be added - To be added: an object of type 'GConf.ChangeSet' + Initializes a new ChangeSet object + an object of type 'GConf.ChangeSet' To be added diff --git a/doc/en/GConf/NoSuchKeyException.xml b/doc/en/GConf/NoSuchKeyException.xml index 3d984586f..a13e20511 100644 --- a/doc/en/GConf/NoSuchKeyException.xml +++ b/doc/en/GConf/NoSuchKeyException.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added - To be added + This Exception is thrown when a key is not found in the user GConf file + This exception is thrown by the Get methods of the ChangeSet and Client classes when a value is requested for a key that does not exist. System.Exception diff --git a/doc/en/GConf/NotifyEventArgs.xml b/doc/en/GConf/NotifyEventArgs.xml index b35de335b..a86f89587 100644 --- a/doc/en/GConf/NotifyEventArgs.xml +++ b/doc/en/GConf/NotifyEventArgs.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added + Arguments of the GConf Notify event that was called due to a GConf key being added, removed or updated. To be added @@ -28,11 +28,11 @@ - To be added + This constructor is called to initialize a NotifyEventArgs with the key/value that was updated, removed or added in GConf To be added: an object of type 'string' To be added: an object of type 'object' - To be added: an object of type 'GConf.NotifyEventArgs' - To be added + an object of type 'GConf.NotifyEventArgs', event arguments to the NotifyEventHandler delegate + @@ -42,8 +42,9 @@ System.Object - To be added - To be added: an object of type 'object' + This NotifyEventArgs property refers to the GConf Value from an entry which modification, addition or removal cause the event to be fired. + + the object stored in the GConf which modification, removal or addition cause the event to be fired. To be added @@ -54,8 +55,8 @@ System.String - To be added - To be added: an object of type 'string' + This NotifyEventArgs property refers to the key which value modification, addition or removal cause the event to be fired. + a string for the key name To be added diff --git a/doc/en/GConf/NotifyEventHandler.xml b/doc/en/GConf/NotifyEventHandler.xml index 8574ad126..d42db2d35 100644 --- a/doc/en/GConf/NotifyEventHandler.xml +++ b/doc/en/GConf/NotifyEventHandler.xml @@ -9,8 +9,13 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + NotifyEventHandler is a delegate object that can be used to notify your program whenever a key's value is changed, either in your program or externally (i.e. via gconf-editor). + You only have to attach a GConf.NotifyEventHandler delegate to a key, this way: + + gconfClient.AddNotify (key, new GConf.NotifyEventHandler(function)); + + +This is very important for graphic interfaces, as it is a good practice to make the application react instantly to preference changes. System.Delegate