Install manifest

[platform/upstream/atk.git] / atk / atkhyperlink.h

diff --git a/atk/atkhyperlink.h b/atk/atkhyperlink.h
index b2dbaac..6e8dc74 100755 (executable)
--- a/atk/atkhyperlink.h
+++ b/atk/atkhyperlink.h
@@ -17,21 +17,34 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
+#error "Only <atk/atk.h> can be included directly."
+#endif
+
 #ifndef __ATK_HYPERLINK_H__
 #define __ATK_HYPERLINK_H__
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
 #include <atk/atkaction.h>
 
+G_BEGIN_DECLS
+
 /*
- * AtkHyperLink encapsulates a link or set of links in a hypertext document.
+ * AtkHyperlink encapsulates a link or set of links in a hypertext document.
  *
  * It implements the AtkAction interface.
  */
 
+/**
+ *AtkHyperlinkStateFlags:
+ *@ATK_HYPERLINK_IS_INLINE: Link is inline
+ *
+ *Describes the type of link
+ **/ 
+typedef enum 
+{
+  ATK_HYPERLINK_IS_INLINE = 1 << 0
+} AtkHyperlinkStateFlags;
+
 #define ATK_TYPE_HYPERLINK                        (atk_hyperlink_get_type ())
 #define ATK_HYPERLINK(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK, AtkHyperlink))
 #define ATK_HYPERLINK_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
@@ -51,61 +64,51 @@ struct _AtkHyperlinkClass
 {
   GObjectClass parent;
 
-  /*
-   * Returns a string specifying the URI associated with the nth anchor
-   * of this link.
-   */
-  gchar*           (* get_uri)             (AtkHyperlink     *link,
+  gchar*           (* get_uri)             (AtkHyperlink     *link_,
                                             gint             i);
-  /*
-   * Returns an object which represents the link action, as appropriate for 
-   * that link.
-   */
-  AtkObject*       (* get_object)          (AtkHyperlink     *link,
+  AtkObject*       (* get_object)          (AtkHyperlink     *link_,
                                             gint             i);
-  /*
-   * Gets the index with the hypertext document at which this link ends
-   */
-  gint             (* get_end_index)       (AtkHyperlink     *link);
-
-  /* 
-   * Gets the index with the hypertext document at which this link begins 
-   */
-  gint             (* get_start_index)     (AtkHyperlink     *link);
-
-  /*
-   * Since the document a link is associated with may have changed, this 
-   * method returns whether or not this link is still valid (with respect
-   * to the document is references)
-   */
-  gboolean         (* is_valid)            (AtkHyperlink     *link);
-
-  /* 
-   * Returns the number of anchors associated with this link
-   */
-  gint            (* get_n_anchors)       (AtkHyperlink     *link);
+  gint             (* get_end_index)       (AtkHyperlink     *link_);
+  gint             (* get_start_index)     (AtkHyperlink     *link_);
+  gboolean         (* is_valid)            (AtkHyperlink     *link_);
+  gint            (* get_n_anchors)       (AtkHyperlink     *link_);
+  guint                   (* link_state)          (AtkHyperlink     *link_);
+  gboolean         (* is_selected_link)    (AtkHyperlink     *link_);
+
+  /* Signals */
+  void             ( *link_activated)      (AtkHyperlink     *link_);
+  AtkFunction      pad1;
 };
 
+ATK_AVAILABLE_IN_ALL
 GType            atk_hyperlink_get_type             (void);
 
-gchar*           atk_hyperlink_get_uri              (AtkHyperlink     *link,
+ATK_AVAILABLE_IN_ALL
+gchar*           atk_hyperlink_get_uri              (AtkHyperlink     *link_,
                                                      gint             i);
 
-AtkObject*       atk_hyperlink_get_object           (AtkHyperlink     *link,
+ATK_AVAILABLE_IN_ALL
+AtkObject*       atk_hyperlink_get_object           (AtkHyperlink     *link_,
                                                      gint             i);
 
-gint             atk_hyperlink_get_end_index        (AtkHyperlink     *link);
+ATK_AVAILABLE_IN_ALL
+gint             atk_hyperlink_get_end_index        (AtkHyperlink     *link_);
 
-gint             atk_hyperlink_get_start_index      (AtkHyperlink     *link);
+ATK_AVAILABLE_IN_ALL
+gint             atk_hyperlink_get_start_index      (AtkHyperlink     *link_);
 
-gboolean         atk_hyperlink_is_valid             (AtkHyperlink     *link);
+ATK_AVAILABLE_IN_ALL
+gboolean         atk_hyperlink_is_valid             (AtkHyperlink     *link_);
 
-gint            atk_hyperlink_get_n_anchors        (AtkHyperlink     *link);
+ATK_AVAILABLE_IN_ALL
+gboolean         atk_hyperlink_is_inline             (AtkHyperlink     *link_);
 
+ATK_AVAILABLE_IN_ALL
+gint            atk_hyperlink_get_n_anchors        (AtkHyperlink     *link_);
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+ATK_DEPRECATED
+gboolean         atk_hyperlink_is_selected_link     (AtkHyperlink     *link_);
 
+G_END_DECLS
 
 #endif /* __ATK_HYPERLINK_H__ */