Small documentation tweak

[~andy/gtk] / gtk / gtktextchild.h

diff --git a/gtk/gtktextchild.h b/gtk/gtktextchild.h
index 6ea7075f6095e257b18862a00007ddebff877bcd..2aa859a91630664e1cf0cce0afead82fac828b4d 100644 (file)
--- a/gtk/gtktextchild.h
+++ b/gtk/gtktextchild.h
@@ -1,23 +1,83 @@
-#ifndef GTK_TEXT_CHILD_H
-#define GTK_TEXT_CHILD_H
+/* GTK - The GIMP Toolkit
+ * gtktextchild.h Copyright (C) 2000 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ */
 
-#include <gtk/gtktexttypes.h>
+/*
+ * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GTK+ Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+#ifndef __GTK_TEXT_CHILD_H__
+#define __GTK_TEXT_CHILD_H__
 
-typedef struct _GtkTextPixbuf GtkTextPixbuf;
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#include <gdk/gdk.h>
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+
+/**
+ * GtkTextChildAnchor:
+ *
+ * A #GtkTextChildAnchor is a spot in the buffer where child widgets can
+ * be "anchored" (inserted inline, as if they were characters). The anchor
+ * can have multiple widgets anchored, to allow for multiple views.
+ */
+typedef struct _GtkTextChildAnchor      GtkTextChildAnchor;
+typedef struct _GtkTextChildAnchorClass GtkTextChildAnchorClass;
+
+#define GTK_TYPE_TEXT_CHILD_ANCHOR              (gtk_text_child_anchor_get_type ())
+#define GTK_TEXT_CHILD_ANCHOR(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_TEXT_CHILD_ANCHOR, GtkTextChildAnchor))
+#define GTK_TEXT_CHILD_ANCHOR_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_CHILD_ANCHOR, GtkTextChildAnchorClass))
+#define GTK_IS_TEXT_CHILD_ANCHOR(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_TEXT_CHILD_ANCHOR))
+#define GTK_IS_TEXT_CHILD_ANCHOR_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_CHILD_ANCHOR))
+#define GTK_TEXT_CHILD_ANCHOR_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_CHILD_ANCHOR, GtkTextChildAnchorClass))
 
-struct _GtkTextPixbuf {
-  GdkPixbuf *pixbuf;
+struct _GtkTextChildAnchor
+{
+  GObject parent_instance;
+
+  /*< private >*/
+  gpointer segment;
 };
 
-GtkTextLineSegment *gtk_text_pixbuf_segment_new(GdkPixbuf *pixbuf);
+struct _GtkTextChildAnchorClass
+{
+  GObjectClass parent_class;
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
+};
+
+GType               gtk_text_child_anchor_get_type    (void) G_GNUC_CONST;
+
+GtkTextChildAnchor* gtk_text_child_anchor_new         (void);
 
+GList*              gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor);
+gboolean            gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor);
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif