]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktexttagtable.c
docs: Move documentation to inline comments: gdkdisplay
[~andy/gtk] / gtk / gtktexttagtable.c
index 6e7ed036571a81380d1812fbcae88832e675a2e5..0bded236a11c290878495809ff0520c6fc8008b1 100644 (file)
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
  */
 
-#include <config.h>
+#include "config.h"
 #include "gtktexttagtable.h"
 #include "gtkmarshalers.h"
 #include "gtktextbuffer.h" /* just for the lame notify_will_remove_tag hack */
 #include "gtkintl.h"
-#include "gtkalias.h"
 
 #include <stdlib.h>
 
+
+/**
+ * SECTION:gtktexttagtable
+ * @Short_description: Collection of tags that can be used together
+ * @Title: GtkTextTagTable
+ *
+ * You may wish to begin by reading the <link linkend="TextWidget">text widget
+ * conceptual overview</link> which gives an overview of all the objects and data
+ * types related to the text widget and how they work together.
+ */
+
+
+struct _GtkTextTagTablePrivate
+{
+  GHashTable *hash;
+  GSList     *anonymous;
+  GSList     *buffers;
+
+  gint anon_count;
+};
+
+
 enum {
   TAG_CHANGED,
   TAG_ADDED,
@@ -67,9 +88,15 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
   object_class->get_property = gtk_text_tag_table_get_property;
   
   object_class->finalize = gtk_text_tag_table_finalize;
-  
+
+  /**
+   * GtkTextTagTable::tag-changed:
+   * @texttagtable: the object which received the signal.
+   * @tag: the changed tag.
+   * @size_changed: whether the size has been changed.
+   */
   signals[TAG_CHANGED] =
-    g_signal_new (I_("tag_changed"),
+    g_signal_new (I_("tag-changed"),
                   G_OBJECT_CLASS_TYPE (object_class),
                   G_SIGNAL_RUN_LAST,
                   G_STRUCT_OFFSET (GtkTextTagTableClass, tag_changed),
@@ -80,8 +107,13 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
                   GTK_TYPE_TEXT_TAG,
                   G_TYPE_BOOLEAN);  
 
+  /**
+   * GtkTextTagTable::tag-added:
+   * @texttagtable: the object which received the signal.
+   * @tag: the added tag.
+   */
   signals[TAG_ADDED] =
-    g_signal_new (I_("tag_added"),
+    g_signal_new (I_("tag-added"),
                   G_OBJECT_CLASS_TYPE (object_class),
                   G_SIGNAL_RUN_LAST,
                   G_STRUCT_OFFSET (GtkTextTagTableClass, tag_added),
@@ -91,8 +123,13 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
                   1,
                   GTK_TYPE_TEXT_TAG);
 
+  /**
+   * GtkTextTagTable::tag-removed:
+   * @texttagtable: the object which received the signal.
+   * @tag: the removed tag.
+   */
   signals[TAG_REMOVED] =
-    g_signal_new (I_("tag_removed"),  
+    g_signal_new (I_("tag-removed"),  
                   G_OBJECT_CLASS_TYPE (object_class),
                   G_SIGNAL_RUN_LAST,
                   G_STRUCT_OFFSET (GtkTextTagTableClass, tag_removed),
@@ -101,12 +138,21 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
                   G_TYPE_NONE,
                   1,
                   GTK_TYPE_TEXT_TAG);
+
+  g_type_class_add_private (klass, sizeof (GtkTextTagTablePrivate));
 }
 
 static void
 gtk_text_tag_table_init (GtkTextTagTable *table)
 {
-  table->hash = g_hash_table_new (g_str_hash, g_str_equal);
+  GtkTextTagTablePrivate *priv;
+
+  table->priv = G_TYPE_INSTANCE_GET_PRIVATE (table,
+                                             GTK_TYPE_TEXT_TAG_TABLE,
+                                             GtkTextTagTablePrivate);
+  priv = table->priv;
+
+  priv->hash = g_hash_table_new (g_str_hash, g_str_equal);
 }
 
 /**
@@ -130,13 +176,15 @@ gtk_text_tag_table_new (void)
 static void
 foreach_unref (GtkTextTag *tag, gpointer data)
 {
+  GtkTextTagTable *table = GTK_TEXT_TAG_TABLE (tag->table);
+  GtkTextTagTablePrivate *priv = table->priv;
   GSList *tmp;
   
   /* We don't want to emit the remove signal here; so we just unparent
    * and unref the tag.
    */
 
-  tmp = tag->table->buffers;
+  tmp = priv->buffers;
   while (tmp != NULL)
     {
       _gtk_text_buffer_notify_will_remove_tag (GTK_TEXT_BUFFER (tmp->data),
@@ -152,18 +200,17 @@ foreach_unref (GtkTextTag *tag, gpointer data)
 static void
 gtk_text_tag_table_finalize (GObject *object)
 {
-  GtkTextTagTable *table;
+  GtkTextTagTable *table = GTK_TEXT_TAG_TABLE (object);
+  GtkTextTagTablePrivate *priv = table->priv;
 
-  table = GTK_TEXT_TAG_TABLE (object);
-  
   gtk_text_tag_table_foreach (table, foreach_unref, NULL);
 
-  g_hash_table_destroy (table->hash);
-  g_slist_free (table->anonymous);
+  g_hash_table_destroy (priv->hash);
+  g_slist_free (priv->anonymous);
 
-  g_slist_free (table->buffers);
-  
-  (* G_OBJECT_CLASS (gtk_text_tag_table_parent_class)->finalize) (object);
+  g_slist_free (priv->buffers);
+
+  G_OBJECT_CLASS (gtk_text_tag_table_parent_class)->finalize (object);
 }
 static void
 gtk_text_tag_table_set_property (GObject      *object,
@@ -211,13 +258,16 @@ void
 gtk_text_tag_table_add (GtkTextTagTable *table,
                         GtkTextTag      *tag)
 {
+  GtkTextTagTablePrivate *priv;
   guint size;
 
   g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
   g_return_if_fail (GTK_IS_TEXT_TAG (tag));
   g_return_if_fail (tag->table == NULL);
 
-  if (tag->name && g_hash_table_lookup (table->hash, tag->name))
+  priv = table->priv;
+
+  if (tag->name && g_hash_table_lookup (priv->hash, tag->name))
     {
       g_warning ("A tag named '%s' is already in the tag table.",
                  tag->name);
@@ -227,11 +277,11 @@ gtk_text_tag_table_add (GtkTextTagTable *table,
   g_object_ref (tag);
 
   if (tag->name)
-    g_hash_table_insert (table->hash, tag->name, tag);
+    g_hash_table_insert (priv->hash, tag->name, tag);
   else
     {
-      table->anonymous = g_slist_prepend (table->anonymous, tag);
-      table->anon_count += 1;
+      priv->anonymous = g_slist_prepend (priv->anonymous, tag);
+      priv->anon_count += 1;
     }
 
   tag->table = table;
@@ -253,16 +303,20 @@ gtk_text_tag_table_add (GtkTextTagTable *table,
  * 
  * Look up a named tag.
  * 
- * Return value: The tag, or %NULL if none by that name is in the table.
+ * Return value: (transfer none): The tag, or %NULL if none by that name is in the table.
  **/
 GtkTextTag*
 gtk_text_tag_table_lookup (GtkTextTagTable *table,
                            const gchar     *name)
 {
+  GtkTextTagTablePrivate *priv;
+
   g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), NULL);
   g_return_val_if_fail (name != NULL, NULL);
 
-  return g_hash_table_lookup (table->hash, name);
+  priv = table->priv;
+
+  return g_hash_table_lookup (priv->hash, name);
 }
 
 /**
@@ -278,16 +332,19 @@ void
 gtk_text_tag_table_remove (GtkTextTagTable *table,
                            GtkTextTag      *tag)
 {
+  GtkTextTagTablePrivate *priv;
   GSList *tmp;
   
   g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
   g_return_if_fail (GTK_IS_TEXT_TAG (tag));
   g_return_if_fail (tag->table == table);
 
+  priv = table->priv;
+
   /* Our little bad hack to be sure buffers don't still have the tag
    * applied to text in the buffer
    */
-  tmp = table->buffers;
+  tmp = priv->buffers;
   while (tmp != NULL)
     {
       _gtk_text_buffer_notify_will_remove_tag (GTK_TEXT_BUFFER (tmp->data),
@@ -304,11 +361,11 @@ gtk_text_tag_table_remove (GtkTextTagTable *table,
   tag->table = NULL;
 
   if (tag->name)
-    g_hash_table_remove (table->hash, tag->name);
+    g_hash_table_remove (priv->hash, tag->name);
   else
     {
-      table->anonymous = g_slist_remove (table->anonymous, tag);
-      table->anon_count -= 1;
+      priv->anonymous = g_slist_remove (priv->anonymous, tag);
+      priv->anon_count -= 1;
     }
 
   g_signal_emit (table, signals[TAG_REMOVED], 0, tag);
@@ -345,7 +402,7 @@ list_foreach (gpointer data, gpointer user_data)
 /**
  * gtk_text_tag_table_foreach:
  * @table: a #GtkTextTagTable
- * @func: a function to call on each tag
+ * @func: (scope call): a function to call on each tag
  * @data: user data
  *
  * Calls @func on each tag in @table, with user data @data.
@@ -357,16 +414,19 @@ gtk_text_tag_table_foreach (GtkTextTagTable       *table,
                             GtkTextTagTableForeach func,
                             gpointer               data)
 {
+  GtkTextTagTablePrivate *priv;
   struct ForeachData d;
 
   g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
   g_return_if_fail (func != NULL);
 
+  priv = table->priv;
+
   d.func = func;
   d.data = data;
 
-  g_hash_table_foreach (table->hash, hash_foreach, &d);
-  g_slist_foreach (table->anonymous, list_foreach, &d);
+  g_hash_table_foreach (priv->hash, hash_foreach, &d);
+  g_slist_foreach (priv->anonymous, list_foreach, &d);
 }
 
 /**
@@ -380,18 +440,22 @@ gtk_text_tag_table_foreach (GtkTextTagTable       *table,
 gint
 gtk_text_tag_table_get_size (GtkTextTagTable *table)
 {
+  GtkTextTagTablePrivate *priv;
+
   g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), 0);
 
-  return g_hash_table_size (table->hash) + table->anon_count;
+  priv = table->priv;
+
+  return g_hash_table_size (priv->hash) + priv->anon_count;
 }
 
 void
 _gtk_text_tag_table_add_buffer (GtkTextTagTable *table,
                                 gpointer         buffer)
 {
-  g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
+  GtkTextTagTablePrivate *priv = table->priv;
 
-  table->buffers = g_slist_prepend (table->buffers, buffer);
+  priv->buffers = g_slist_prepend (priv->buffers, buffer);
 }
 
 static void
@@ -408,12 +472,9 @@ void
 _gtk_text_tag_table_remove_buffer (GtkTextTagTable *table,
                                    gpointer         buffer)
 {
-  g_return_if_fail (GTK_IS_TEXT_TAG_TABLE (table));
+  GtkTextTagTablePrivate *priv = table->priv;
 
   gtk_text_tag_table_foreach (table, foreach_remove_tag, buffer);
-  
-  table->buffers = g_slist_remove (table->buffers, buffer);
-}
 
-#define __GTK_TEXT_TAG_TABLE_C__
-#include "gtkaliasdef.c"
+  priv->buffers = g_slist_remove (priv->buffers, buffer);
+}