]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktextbuffer.h
Add hints on how to handle "no window" widgets. (#136347)
[~andy/gtk] / gtk / gtktextbuffer.h
index b54c352d1d5f805d38c0a2657c684162a789acda..419ad4d3c38ac3ac79f87123e0f120a76a97b70a 100644 (file)
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#ifndef GTK_TEXT_BUFFER_H
-#define GTK_TEXT_BUFFER_H
+#ifndef __GTK_TEXT_BUFFER_H__
+#define __GTK_TEXT_BUFFER_H__
 
 #include <gtk/gtkwidget.h>
+#include <gtk/gtkclipboard.h>
 #include <gtk/gtktexttagtable.h>
 #include <gtk/gtktextiter.h>
 #include <gtk/gtktextmark.h>
 #include <gtk/gtktextchild.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 /*
  * This is the PUBLIC representation of a text buffer.
@@ -47,24 +46,27 @@ typedef struct _GtkTextBTree GtkTextBTree;
 typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;
 
 #define GTK_TYPE_TEXT_BUFFER            (gtk_text_buffer_get_type ())
-#define GTK_TEXT_BUFFER(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBuffer))
-#define GTK_TEXT_BUFFER_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
-#define GTK_IS_TEXT_BUFFER(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_TEXT_BUFFER))
-#define GTK_IS_TEXT_BUFFER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_BUFFER))
-#define GTK_TEXT_BUFFER_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
+#define GTK_TEXT_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBuffer))
+#define GTK_TEXT_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
+#define GTK_IS_TEXT_BUFFER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_BUFFER))
+#define GTK_IS_TEXT_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_BUFFER))
+#define GTK_TEXT_BUFFER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_BUFFER, GtkTextBufferClass))
 
 typedef struct _GtkTextBufferClass GtkTextBufferClass;
 
 struct _GtkTextBuffer
 {
-  GtkObject parent_instance;
+  GObject parent_instance;
 
   GtkTextTagTable *tag_table;
   GtkTextBTree *btree;
 
-  GtkTextBuffer *clipboard_contents;
+  GSList *clipboard_contents_buffers;
+  GSList *selection_clipboards;
 
   GtkTextLogAttrCache *log_attr_cache;
+
+  guint user_action_count;
   
   /* Whether the buffer has been modified since last save */
   guint modified : 1;
@@ -72,19 +74,24 @@ struct _GtkTextBuffer
 
 struct _GtkTextBufferClass
 {
-  GtkObjectClass parent_class;
+  GObjectClass parent_class;
 
   void (* insert_text)     (GtkTextBuffer *buffer,
                             GtkTextIter *pos,
                             const gchar *text,
-                            gint length,
-                            gboolean interactive);
+                            gint length);
 
+  void (* insert_pixbuf)   (GtkTextBuffer *buffer,
+                            GtkTextIter   *pos,
+                            GdkPixbuf     *pixbuf);
 
-  void (* delete_text)     (GtkTextBuffer *buffer,
-                            GtkTextIter *start,
-                            GtkTextIter *end,
-                            gboolean interactive);
+  void (* insert_child_anchor)   (GtkTextBuffer      *buffer,
+                                  GtkTextIter        *pos,
+                                  GtkTextChildAnchor *anchor);
+  
+  void (* delete_range)     (GtkTextBuffer *buffer,
+                             GtkTextIter   *start,
+                             GtkTextIter   *end);
 
   /* Only for text/widgets/pixbuf changed, marks/tags don't cause this
    * to be emitted
@@ -113,9 +120,20 @@ struct _GtkTextBufferClass
                                const GtkTextIter *start_char,
                                const GtkTextIter *end_char);
 
+  /* Called at the start and end of an atomic user action */
+  void (* begin_user_action)  (GtkTextBuffer *buffer);
+  void (* end_user_action)    (GtkTextBuffer *buffer);
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
+  void (*_gtk_reserved5) (void);
+  void (*_gtk_reserved6) (void);
 };
 
-GtkType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
+GType        gtk_text_buffer_get_type       (void) G_GNUC_CONST;
 
 
 
@@ -166,25 +184,27 @@ void    gtk_text_buffer_insert_with_tags          (GtkTextBuffer     *buffer,
                                                    const gchar       *text,
                                                    gint               len,
                                                    GtkTextTag        *first_tag,
-                                                   ...);
+                                                   ...) G_GNUC_NULL_TERMINATED;
 
 void    gtk_text_buffer_insert_with_tags_by_name  (GtkTextBuffer     *buffer,
                                                    GtkTextIter       *iter,
                                                    const gchar       *text,
                                                    gint               len,
                                                    const gchar       *first_tag_name,
-                                                   ...);
+                                                   ...) G_GNUC_NULL_TERMINATED;
 
 /* Delete from the buffer */
 void     gtk_text_buffer_delete             (GtkTextBuffer *buffer,
-                                             GtkTextIter   *start,
-                                             GtkTextIter   *end);
+                                            GtkTextIter   *start,
+                                            GtkTextIter   *end);
 gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
-                                             GtkTextIter   *start_iter,
-                                             GtkTextIter   *end_iter,
-                                             gboolean       default_editable);
-
-
+                                            GtkTextIter   *start_iter,
+                                            GtkTextIter   *end_iter,
+                                            gboolean       default_editable);
+gboolean gtk_text_buffer_backspace          (GtkTextBuffer *buffer,
+                                            GtkTextIter   *iter,
+                                            gboolean       interactive,
+                                            gboolean       default_editable);
 
 /* Obtain strings from the buffer */
 gchar          *gtk_text_buffer_get_text            (GtkTextBuffer     *buffer,
@@ -202,7 +222,12 @@ void gtk_text_buffer_insert_pixbuf         (GtkTextBuffer *buffer,
                                             GtkTextIter   *iter,
                                             GdkPixbuf     *pixbuf);
 
-/* Create a child anchor */
+/* Insert a child anchor */
+void               gtk_text_buffer_insert_child_anchor (GtkTextBuffer      *buffer,
+                                                        GtkTextIter        *iter,
+                                                        GtkTextChildAnchor *anchor);
+
+/* Convenience, create and insert a child anchor */
 GtkTextChildAnchor *gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer,
                                                          GtkTextIter   *iter);
 
@@ -228,40 +253,48 @@ void gtk_text_buffer_delete_mark_by_name (GtkTextBuffer     *buffer,
 GtkTextMark* gtk_text_buffer_get_insert          (GtkTextBuffer *buffer);
 GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer);
 
-/* efficiently move insert and selection_bound to same location */
+/* efficiently move insert and selection_bound at the same time */
 void gtk_text_buffer_place_cursor (GtkTextBuffer     *buffer,
                                    const GtkTextIter *where);
+void gtk_text_buffer_select_range (GtkTextBuffer     *buffer,
+                                   const GtkTextIter *ins,
+                                  const GtkTextIter *bound);
 
 
 
 /* Tag manipulation */
 void gtk_text_buffer_apply_tag             (GtkTextBuffer     *buffer,
                                             GtkTextTag        *tag,
-                                            const GtkTextIter *start_index,
-                                            const GtkTextIter *end_index);
+                                            const GtkTextIter *start,
+                                            const GtkTextIter *end);
 void gtk_text_buffer_remove_tag            (GtkTextBuffer     *buffer,
                                             GtkTextTag        *tag,
-                                            const GtkTextIter *start_index,
-                                            const GtkTextIter *end_index);
+                                            const GtkTextIter *start,
+                                            const GtkTextIter *end);
 void gtk_text_buffer_apply_tag_by_name     (GtkTextBuffer     *buffer,
                                             const gchar       *name,
-                                            const GtkTextIter *start_index,
-                                            const GtkTextIter *end_index);
+                                            const GtkTextIter *start,
+                                            const GtkTextIter *end);
 void gtk_text_buffer_remove_tag_by_name    (GtkTextBuffer     *buffer,
                                             const gchar       *name,
-                                            const GtkTextIter *start_index,
-                                            const GtkTextIter *end_index);
+                                            const GtkTextIter *start,
+                                            const GtkTextIter *end);
+void gtk_text_buffer_remove_all_tags       (GtkTextBuffer     *buffer,
+                                            const GtkTextIter *start,
+                                            const GtkTextIter *end);
 
 
 /* You can either ignore the return value, or use it to
  * set the attributes of the tag. tag_name can be NULL
  */
-/* FIXME this should take a varargs list of tag attributes I think */
 GtkTextTag    *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
-                                           const gchar   *tag_name);
+                                           const gchar   *tag_name,
+                                           const gchar   *first_property_name,
+                                           ...) G_GNUC_NULL_TERMINATED;
 
 /* Obtain iterators pointed at various places, then you can move the
-   iterator around using the GtkTextIter operators */
+ * iterator around using the GtkTextIter operators
+ */
 void gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
                                               GtkTextIter   *iter,
                                               gint           line_number,
@@ -276,7 +309,9 @@ void gtk_text_buffer_get_iter_at_offset      (GtkTextBuffer *buffer,
 void gtk_text_buffer_get_iter_at_line        (GtkTextBuffer *buffer,
                                               GtkTextIter   *iter,
                                               gint           line_number);
-void gtk_text_buffer_get_last_iter           (GtkTextBuffer *buffer,
+void gtk_text_buffer_get_start_iter          (GtkTextBuffer *buffer,
+                                              GtkTextIter   *iter);
+void gtk_text_buffer_get_end_iter            (GtkTextBuffer *buffer,
                                               GtkTextIter   *iter);
 void gtk_text_buffer_get_bounds              (GtkTextBuffer *buffer,
                                               GtkTextIter   *start,
@@ -298,17 +333,23 @@ void gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer      *buffer,
    flag, but if you would like them to you can connect a handler to
    the tag/mark signals and call set_modified in your handler */
 
-gboolean        gtk_text_buffer_modified                (GtkTextBuffer *buffer);
+gboolean        gtk_text_buffer_get_modified            (GtkTextBuffer *buffer);
 void            gtk_text_buffer_set_modified            (GtkTextBuffer *buffer,
                                                          gboolean       setting);
 
-void            gtk_text_buffer_paste_primary           (GtkTextBuffer       *buffer,
-                                                         const GtkTextIter   *override_location,
-                                                         gboolean             default_editable);
+void gtk_text_buffer_add_selection_clipboard    (GtkTextBuffer     *buffer,
+                                                GtkClipboard      *clipboard);
+void gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer     *buffer,
+                                                GtkClipboard      *clipboard);
+
 void            gtk_text_buffer_cut_clipboard           (GtkTextBuffer *buffer,
+                                                        GtkClipboard  *clipboard,
                                                          gboolean       default_editable);
-void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer);
+void            gtk_text_buffer_copy_clipboard          (GtkTextBuffer *buffer,
+                                                        GtkClipboard  *clipboard);
 void            gtk_text_buffer_paste_clipboard         (GtkTextBuffer *buffer,
+                                                        GtkClipboard  *clipboard,
+                                                        GtkTextIter   *override_location,
                                                          gboolean       default_editable);
 
 gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
@@ -317,7 +358,11 @@ gboolean        gtk_text_buffer_get_selection_bounds    (GtkTextBuffer *buffer,
 gboolean        gtk_text_buffer_delete_selection        (GtkTextBuffer *buffer,
                                                          gboolean       interactive,
                                                          gboolean       default_editable);                                                    
-                                                    
+
+/* Called to specify atomic user actions, used to implement undo */
+void            gtk_text_buffer_begin_user_action       (GtkTextBuffer *buffer);
+void            gtk_text_buffer_end_user_action         (GtkTextBuffer *buffer);
+
 /* INTERNAL private stuff */
 void            _gtk_text_buffer_spew                  (GtkTextBuffer      *buffer);
 
@@ -327,8 +372,9 @@ const PangoLogAttr* _gtk_text_buffer_get_line_log_attrs (GtkTextBuffer     *buff
                                                          const GtkTextIter *anywhere_in_line,
                                                          gint              *char_len);
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+void _gtk_text_buffer_notify_will_remove_tag (GtkTextBuffer *buffer,
+                                              GtkTextTag    *tag);
+
+G_END_DECLS
 
 #endif