forked from AuroraMiddleware/gtk
a4762fbff4
2000-07-25 Havoc Pennington <hp@redhat.com> * gtk/testtext.c, gtk/testtextbuffer.c: update to reflect text widget changes. * gtk/gtktextview.h: To be consistent with usage of "line" throughout the API to mean "newline-terminated thingy", change MOVEMENT_LINE to be MOVEMENT_WRAPPED_LINE, and MOVEMENT_PARAGRAPH to MOVEMENT_LINE. (GtkTextView): Add flags for default editability, and whether to show the cursor. Add functions to get/set that. Add (gtk_text_view_get_iter_location): new function * gtk/gtktexttypes.h: Move GtkTextLine typedef from here to gtktextlayout.h (g_convert): Add g_convert temporarily, will go in glib in a bit * gtk/gtktexttagtable.h: include gtktexttag.h, and define GtkTextTagTableForeach instead of brokenly using GHFunc. Change gtk_text_tag_table_foreach() so it doesn't use GHFunc. * gtk/gtktexttagprivate.h: Remove GtkTextStyleValues from here, moved to public header. * gtk/gtktexttag.h: Rename the "elide" attribute of tags to "invisible", since "elide" was a bad name. (gtk_text_tag_get_priority): Added (GtkTextStyleValues): put this in public header, along with functions to use it. * gtk/gtktextmarkprivate.h: Include more headers, since we no longer include gtktextbtree.h. * gtk/gtktextmark.h: Add gtk_text_mark_ref, gtk_text_mark_unref, gtk_text_mark_deleted * gtk/gtktextlayout.h: Don't include the "really private" headers, only buffer/iter. Forward declare GtkTextLIne and GtkTextLineData to make this possible. Now we only need to install gtktextlayout.h, not gtktextbtree.h and gtktext*private.h. (However the Makefile.am isn't changed yet because of the logistics of merging gtk-hp-patches piecemeal) * gtk/gtktextiterprivate.h: include btree header, so it compiles; rename gtk_text_iter_get_line to gtk_text_iter_get_text_line since gtk_text_iter_get_line is now used in the public API for a different purpose. * gtk/gtktextiter.h: Clean up function names to be more consistent. Always call char offset "offset" and byte index "index". A "line" is always a line number. (gtk_text_iter_is_last): new function, more efficient than the existing way to check (gtk_text_iter_is_first): new function, also more efficient (gtk_text_iter_up_lines, gtk_text_iter_down_lines): Remove these (gtk_text_iter_next_char, gtk_text_iter_prev_char): Renamed from gtk_text_iter_forward_char, etc. (gtk_text_iter_forward_to_tag_toggle): Renamed from forward_find_tag_toggle, since this isn't a linear search (GtkTextCharPredicate): rename from GtkTextViewCharPredicate (gtk_text_iter_forward_search, gtk_text_iter_backward_search): New functions, search for a buffer substring. * gtk/gtktextbuffer.h: Add fields to store whether a paste is interactive and default editable (since we need to store that info until we receive the selection data). Remove all the _at_char and at_line etc. versions of functions; only have iterator versions. Add _interactive() versions of functions, that consider the editability of text. (FIXME add interactive flag to the insert/delete signals per Darin's suggestion) (gtk_text_buffer_get_tag_table): new function, demand-creates the tag table if necessary Remove declaration of gtk_text_buffer_get_iter_from_string (_gtk_text_buffer_get_btree): private/internal function, added. * gtk/gtktextbtree.h: Remove forward decl of GtkTextLineData. (gtk_text_line_is_last): new function
287 lines
13 KiB
C
287 lines
13 KiB
C
#ifndef GTK_TEXT_BUFFER_H
|
|
#define GTK_TEXT_BUFFER_H
|
|
|
|
#include <gtk/gtkwidget.h>
|
|
#include <gtk/gtktexttagtable.h>
|
|
#include <gtk/gtktextiter.h>
|
|
#include <gtk/gtktextmark.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/*
|
|
* This is the PUBLIC representation of a text buffer.
|
|
* GtkTextBTree is the PRIVATE internal representation of it.
|
|
*/
|
|
|
|
typedef struct _GtkTextBTree GtkTextBTree;
|
|
|
|
#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))
|
|
|
|
typedef struct _GtkTextBufferClass GtkTextBufferClass;
|
|
|
|
struct _GtkTextBuffer {
|
|
GtkObject parent_instance;
|
|
|
|
GtkTextTagTable *tag_table;
|
|
GtkTextBTree *btree;
|
|
|
|
/* Text currently pasted to the clipboard */
|
|
gchar *clipboard_text;
|
|
|
|
/* Whether the buffer has been modified since last save */
|
|
gboolean modified;
|
|
|
|
/* We use this for selections */
|
|
GtkWidget *selection_widget;
|
|
gboolean have_selection;
|
|
gboolean selection_handlers_installed;
|
|
gboolean paste_interactive;
|
|
gboolean paste_default_editable;
|
|
};
|
|
|
|
struct _GtkTextBufferClass {
|
|
GtkObjectClass parent_class;
|
|
|
|
void (* insert_text) (GtkTextBuffer *buffer,
|
|
GtkTextIter *pos,
|
|
const gchar *text,
|
|
gint length);
|
|
|
|
|
|
void (* delete_text) (GtkTextBuffer *buffer,
|
|
GtkTextIter *start,
|
|
GtkTextIter *end);
|
|
|
|
/* Only for text changed, marks/tags don't cause this
|
|
to be emitted */
|
|
void (* changed) (GtkTextBuffer *buffer);
|
|
|
|
|
|
/* New value for the modified flag */
|
|
void (* modified_changed) (GtkTextBuffer *buffer);
|
|
|
|
/* Mark moved or created */
|
|
void (* mark_set) (GtkTextBuffer *buffer,
|
|
const GtkTextIter *location,
|
|
GtkTextMark *mark);
|
|
|
|
void (* mark_deleted) (GtkTextBuffer *buffer,
|
|
GtkTextMark *mark);
|
|
|
|
void (* apply_tag) (GtkTextBuffer *buffer,
|
|
GtkTextTag *tag,
|
|
const GtkTextIter *start_char,
|
|
const GtkTextIter *end_char);
|
|
|
|
void (* remove_tag) (GtkTextBuffer *buffer,
|
|
GtkTextTag *tag,
|
|
const GtkTextIter *start_char,
|
|
const GtkTextIter *end_char);
|
|
|
|
};
|
|
|
|
GtkType gtk_text_buffer_get_type (void);
|
|
|
|
|
|
|
|
/* table is NULL to create a new one */
|
|
GtkTextBuffer *gtk_text_buffer_new (GtkTextTagTable *table);
|
|
gint gtk_text_buffer_get_line_count (GtkTextBuffer *buffer);
|
|
gint gtk_text_buffer_get_char_count (GtkTextBuffer *buffer);
|
|
|
|
|
|
GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer *buffer);
|
|
|
|
/* Insert into the buffer */
|
|
void gtk_text_buffer_insert (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
const gchar *text,
|
|
gint len);
|
|
void gtk_text_buffer_insert_at_cursor (GtkTextBuffer *buffer,
|
|
const gchar *text,
|
|
gint len);
|
|
|
|
gboolean gtk_text_buffer_insert_interactive (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
const gchar *text,
|
|
gint len,
|
|
gboolean default_editable);
|
|
gboolean gtk_text_buffer_insert_interactive_at_cursor (GtkTextBuffer *buffer,
|
|
const gchar *text,
|
|
gint len,
|
|
gboolean default_editable);
|
|
|
|
|
|
/* Delete from the buffer */
|
|
void gtk_text_buffer_delete (GtkTextBuffer *buffer,
|
|
GtkTextIter *start_iter,
|
|
GtkTextIter *end_iter);
|
|
gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer,
|
|
GtkTextIter *start_iter,
|
|
GtkTextIter *end_iter,
|
|
gboolean default_editable);
|
|
|
|
|
|
|
|
/* Obtain strings from the buffer */
|
|
gchar *gtk_text_buffer_get_text (GtkTextBuffer *buffer,
|
|
const GtkTextIter *start_iter,
|
|
const GtkTextIter *end_iter,
|
|
gboolean include_hidden_chars);
|
|
|
|
gchar *gtk_text_buffer_get_slice (GtkTextBuffer *buffer,
|
|
const GtkTextIter *start_iter,
|
|
const GtkTextIter *end_iter,
|
|
gboolean include_hidden_chars);
|
|
|
|
/* Insert a pixmap */
|
|
void gtk_text_buffer_insert_pixmap (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
GdkPixmap *pixmap,
|
|
GdkBitmap *mask);
|
|
|
|
/* Mark manipulation */
|
|
GtkTextMark *gtk_text_buffer_create_mark (GtkTextBuffer *buffer,
|
|
const gchar *mark_name,
|
|
const GtkTextIter *where,
|
|
gboolean left_gravity);
|
|
void gtk_text_buffer_move_mark (GtkTextBuffer *buffer,
|
|
GtkTextMark *mark,
|
|
const GtkTextIter *where);
|
|
void gtk_text_buffer_delete_mark (GtkTextBuffer *buffer,
|
|
GtkTextMark *mark);
|
|
GtkTextMark *gtk_text_buffer_get_mark (GtkTextBuffer *buffer,
|
|
const gchar *name);
|
|
|
|
|
|
/* efficiently move insert and selection_bound to same location */
|
|
void gtk_text_buffer_place_cursor (GtkTextBuffer *buffer,
|
|
const GtkTextIter *where);
|
|
|
|
|
|
|
|
/* Tag manipulation */
|
|
void gtk_text_buffer_apply_tag (GtkTextBuffer *buffer,
|
|
GtkTextTag *tag,
|
|
const GtkTextIter *start_index,
|
|
const GtkTextIter *end_index);
|
|
void gtk_text_buffer_remove_tag (GtkTextBuffer *buffer,
|
|
GtkTextTag *tag,
|
|
const GtkTextIter *start_index,
|
|
const GtkTextIter *end_index);
|
|
void gtk_text_buffer_apply_tag_by_name (GtkTextBuffer *buffer,
|
|
const gchar *name,
|
|
const GtkTextIter *start_index,
|
|
const GtkTextIter *end_index);
|
|
void gtk_text_buffer_remove_tag_by_name (GtkTextBuffer *buffer,
|
|
const gchar *name,
|
|
const GtkTextIter *start_index,
|
|
const GtkTextIter *end_index);
|
|
|
|
|
|
/* You can either ignore the return value, or use it to
|
|
* set the attributes of the tag. tag_name can be NULL
|
|
*/
|
|
GtkTextTag *gtk_text_buffer_create_tag (GtkTextBuffer *buffer,
|
|
const gchar *tag_name);
|
|
|
|
/* Obtain iterators pointed at various places, then you can move the
|
|
iterator around using the GtkTextIter operators */
|
|
void gtk_text_buffer_get_iter_at_line_offset (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
gint line_number,
|
|
gint char_offset);
|
|
void gtk_text_buffer_get_iter_at_offset (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
gint char_offset);
|
|
void gtk_text_buffer_get_iter_at_line (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
gint line_number);
|
|
void gtk_text_buffer_get_last_iter (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter);
|
|
void gtk_text_buffer_get_bounds (GtkTextBuffer *buffer,
|
|
GtkTextIter *start,
|
|
GtkTextIter *end);
|
|
void gtk_text_buffer_get_iter_at_mark (GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
GtkTextMark *mark);
|
|
|
|
|
|
|
|
/* There's no get_first_iter because you just get the iter for
|
|
line or char 0 */
|
|
|
|
GSList *gtk_text_buffer_get_tags (GtkTextBuffer *buffer,
|
|
const GtkTextIter *iter);
|
|
|
|
|
|
/* Used to keep track of whether the buffer needs saving; anytime the
|
|
buffer contents change, the modified flag is turned on. Whenever
|
|
you save, turn it off. Tags and marks do not affect the modified
|
|
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);
|
|
void gtk_text_buffer_set_modified (GtkTextBuffer *buffer,
|
|
gboolean setting);
|
|
void gtk_text_buffer_set_clipboard_contents (GtkTextBuffer *buffer,
|
|
const gchar *text);
|
|
const gchar *gtk_text_buffer_get_clipboard_contents (GtkTextBuffer *buffer);
|
|
|
|
|
|
void gtk_text_buffer_paste_primary_selection (GtkTextBuffer *buffer,
|
|
GtkTextIter *override_location,
|
|
guint32 time,
|
|
gboolean interactive,
|
|
gboolean default_editable);
|
|
gboolean gtk_text_buffer_delete_selection (GtkTextBuffer *buffer,
|
|
gboolean interactive,
|
|
gboolean default_editable);
|
|
void gtk_text_buffer_cut (GtkTextBuffer *buffer,
|
|
guint32 time,
|
|
gboolean interactive,
|
|
gboolean default_editable);
|
|
void gtk_text_buffer_copy (GtkTextBuffer *buffer,
|
|
guint32 time);
|
|
void gtk_text_buffer_paste_clipboard (GtkTextBuffer *buffer,
|
|
guint32 time,
|
|
gboolean interactive,
|
|
gboolean default_editable);
|
|
gboolean gtk_text_buffer_get_selection_bounds (GtkTextBuffer *buffer,
|
|
GtkTextIter *start,
|
|
GtkTextIter *end);
|
|
|
|
|
|
/* This function is not implemented. */
|
|
gboolean gtk_text_buffer_find_string(GtkTextBuffer *buffer,
|
|
GtkTextIter *iter,
|
|
const gchar *str,
|
|
const GtkTextIter *start,
|
|
const GtkTextIter *end);
|
|
|
|
#if 0
|
|
/* Waiting on glib 1.4 regexp facility */
|
|
gboolean gtk_text_buffer_find_regexp(GtkTextBuffer *buffer,
|
|
GRegexp *regexp,
|
|
const GtkTextIter *start,
|
|
const GtkTextIter *end);
|
|
#endif
|
|
|
|
/* INTERNAL private stuff */
|
|
void gtk_text_buffer_spew (GtkTextBuffer *buffer);
|
|
|
|
GtkTextBTree* _gtk_text_buffer_get_btree (GtkTextBuffer *buffer);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif
|