Include the marshallers header, not the source

[platform/upstream/atk.git] / atk / atkutil.c

diff --git a/atk/atkutil.c b/atk/atkutil.c
old mode 100755 (executable)
new mode 100644 (file)
index 058fc6d..4b3c68d
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -17,10 +17,11 @@
  * Boston, MA 02111-1307, USA.
  */
 
-#include "atkutil.h"
-#include "atkmarshal.c"
 #include "config.h"
 
+#include "atkutil.h"
+#include "atkmarshal.h"
+
 /**
  * SECTION:atkutil
  * @Short_description: A set of ATK utility functions for event and toolkit support.
@@ -99,9 +100,8 @@ struct _FocusTracker {
  * ATK interface if any specific work needs to be done to enable
  * focus tracking.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself.
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself.
  *
  **/
 void
@@ -119,10 +119,9 @@ atk_focus_tracker_init (AtkEventListenerInit    init)
  * Adds the specified function to the list of functions to be called
  * when an object receives focus.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself. If you need focus tracking on your
- * implementation, subscribe to the state-changed:focused signal.
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
+ * implementation, subscribe to the #AtkObject::state-change "focused" signal.
  *
  * Returns: added focus tracker id, or 0 on failure.
  **/
@@ -159,10 +158,9 @@ atk_add_focus_tracker (AtkEventListener   focus_tracker)
  * atk_remove_focus_tracker:
  * @tracker_id: the id of the focus tracker to remove
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself. If you need focus tracking on your
- * implementation, subscribe to the state-changed:focused signal.
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
+ * implementation, subscribe to the #AtkObject::state-change "focused" signal.
  *
  * Removes the specified focus tracker from the list of functions
  * to be called when any object receives focus.
@@ -197,10 +195,11 @@ atk_remove_focus_tracker (guint            tracker_id)
  * Cause the focus tracker functions which have been specified to be
  * executed for the object.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself.
- *
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. As #AtkObject::focus-event was
+ * deprecated in favor of a #AtkObject::state-change signal, in order
+ * to notify a focus change on your implementation, you can use
+ * atk_object_notify_state_change() instead.
  **/
 void
 atk_focus_tracker_notify (AtkObject       *object)
@@ -353,11 +352,11 @@ atk_util_real_remove_global_event_listener (guint remove_listener)
  * when an ATK event of type event_type occurs.
  *
  * The format of event_type is the following:
- *  "ATK:<atk_type>:<atk_event>:<atk_event_detail>
+ *  "ATK:&lt;atk_type&gt;:&lt;atk_event&gt;:&lt;atk_event_detail&gt;
  *
- * Where "ATK" works as the namespace, <atk_interface> is the name of
- * the ATK type (interface or object), <atk_event> is the name of the
- * signal defined on that interface and <atk_event_detail> is the
+ * Where "ATK" works as the namespace, &lt;atk_interface&gt; is the name of
+ * the ATK type (interface or object), &lt;atk_event&gt; is the name of the
+ * signal defined on that interface and &lt;atk_event_detail&gt; is the
  * gsignal detail of that signal. You can find more info about gsignal
  * details here:
  * http://developer.gnome.org/gobject/stable/gobject-Signals.html
@@ -376,6 +375,13 @@ atk_util_real_remove_global_event_listener (guint remove_listener)
  * Toolkit implementor note: this method is not intended to be used by
  * ATK implementors but by ATK consumers.
  *
+ * ATK consumers note: as this method adds a listener for a given ATK
+ * type, that type should be already registered on the GType system
+ * before calling this method. A simple way to do that is creating an
+ * instance of #AtkNoOpObject. This class implements all ATK
+ * interfaces, so creating the instance will register all ATK types as
+ * a collateral effect.
+ *
  * Returns: added event listener id, or 0 on failure.
  **/
 guint