textbuffer.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TEXTBUFFER_H
#define _GTKMM_TEXTBUFFER_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: textbuffer.hg,v 1.20 2006/11/20 09:19:49 murrayc Exp $ */
 
/* Copyright(C) 1998-2002 The gtkmm Development Team
 *
 * 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.1 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, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
// This is for including the config header before any code (such as
// the #ifndef GTKMM_DISABLE_DEPRECATED in deprecated classes) is generated:
 
 
#include <gtkmm/object.h>
#include <gtkmm/texttagtable.h>
#include <gtkmm/textchildanchor.h>
#include <gtkmm/textmark.h>
#include <gtkmm/textiter.h>
#include <gtkmm/clipboard.h>
#include <gdkmm/pixbuf.h>
#include <gtkmmconfig.h>
#include <utility>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTextBuffer GtkTextBuffer;
typedef struct _GtkTextBufferClass GtkTextBufferClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TextBuffer_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class TextMark;
class TextIter;
 
class TextBuffer : public Glib::Object
{
   
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef TextBuffer CppObjectType;
  typedef TextBuffer_Class CppClassType;
  typedef GtkTextBuffer BaseObjectType;
  typedef GtkTextBufferClass BaseClassType;
 
private:  friend class TextBuffer_Class;
  static CppClassType textbuffer_class_;
 
private:
  // noncopyable
  TextBuffer(const TextBuffer&);
  TextBuffer& operator=(const TextBuffer&);
 
protected:
  explicit TextBuffer(const Glib::ConstructParams& construct_params);
  explicit TextBuffer(GtkTextBuffer* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~TextBuffer();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkTextBuffer*       gobj()       { return reinterpret_cast<GtkTextBuffer*>(gobject_); }
 
  const GtkTextBuffer* gobj() const { return reinterpret_cast<GtkTextBuffer*>(gobject_); }
 
  GtkTextBuffer* gobj_copy();
 
private:
 
   
public:
  typedef TextIter iterator;
  typedef TextTag Tag;
  typedef TextTagTable TagTable;
  typedef TextMark Mark;
  typedef TextChildAnchor ChildAnchor;
 
protected:
  TextBuffer();
  explicit TextBuffer(const Glib::RefPtr<TagTable>& tag_table);
 
public:
  
  static Glib::RefPtr<TextBuffer> create();
 
  
  static Glib::RefPtr<TextBuffer> create(const Glib::RefPtr<TagTable>& tag_table);
 
 
  int get_line_count() const;
  
  int get_char_count() const;
 
  int size() const;
 
  
  Glib::RefPtr<TextBuffer::TagTable> get_tag_table();
  
  Glib::RefPtr<const TextBuffer::TagTable> get_tag_table() const;
 
  void set_text(const Glib::ustring& text);
 
  void set_text(const char* text_begin, const char* text_end);
  
 
  #ifndef GTKMM_DISABLE_DEPRECATED
 
  void assign(const Glib::ustring& text);
 
  void assign(const char* text_begin, const char* text_end);
  #endif // GTKMM_DISABLE_DEPRECATED
 
 
  //TODO: Make all insert() methods have the same return type:
 
  iterator insert(const iterator& pos, const Glib::ustring& text);
 
  iterator insert(const iterator& pos, const char* text_begin, const char* text_end);
 
  void insert_at_cursor(const Glib::ustring& text);
 
  void insert_at_cursor(const char* text_begin, const char* text_end);
 
  std::pair<iterator,bool> insert_interactive(
      const iterator& pos, const Glib::ustring& text, bool default_editable = true);
 
  std::pair<iterator,bool> insert_interactive(
      const iterator& pos, const char* text_begin, const char* text_end, bool default_editable = true);
 
  bool insert_interactive_at_cursor(const Glib::ustring& text, bool default_editable = true);
 
  bool insert_interactive_at_cursor(const char* text_begin, const char* text_end,
                                    bool default_editable = true);
 
  iterator insert(const iterator& pos, const iterator& range_begin, const iterator& range_end);
  
 
  std::pair<iterator,bool> insert_interactive(const iterator& pos, const iterator& range_begin, const iterator& range_end, bool default_editable = true);
  
 
  iterator insert_with_tag(const iterator& pos, const Glib::ustring& text, const Glib::RefPtr<Tag>& tag);
  iterator insert_with_tag(const iterator& pos, const char* text_begin, const char* text_end, const Glib::RefPtr<Tag>& tag);
 
  iterator insert_with_tag(const iterator& pos, const Glib::ustring& text, const Glib::ustring& tag_name);
  iterator insert_with_tag(const iterator& pos, const char* text_begin, const char* text_end, const Glib::ustring& tag_name);
 
  iterator insert_with_tags(const iterator& pos, const Glib::ustring& text,
                            const Glib::ArrayHandle< Glib::RefPtr<Tag> >& tags);
 
  iterator insert_with_tags(const iterator& pos, const char* text_begin, const char* text_end,
                            const Glib::ArrayHandle< Glib::RefPtr<Tag> >& tags);
 
  iterator insert_with_tags_by_name(const iterator& pos, const Glib::ustring& text,
                                    const Glib::StringArrayHandle& tag_names);
 
 
  iterator insert_with_tags_by_name(const iterator& pos, const char* text_begin, const char* text_end,
                                    const Glib::StringArrayHandle& tag_names);
 
  /* Deletes all text between @a range_begin and @a range_end. The order of range_begin and range_end is not actually relevant.
   * This function actually emits the "delete_range" signal, and the default handler of that signal deletes the text.
   * Because the buffer is modified, all outstanding iterators become invalid after calling this function.
   * @param range_begin
   * @param range_end
   * @result An iterator that points to the location where text was deleted.
   */
  iterator erase(const iterator& range_begin, const iterator& range_end);
  
 
   /* Deletes all editable text between @a range_begin and @a range_end. The order of range_begin and range_end is not actually relevant.
   * This function actually emits the "delete_range" signal, and the default handler of that signal deletes the text.
   * Because the buffer is modified, all outstanding iterators become invalid after calling this function.
   *
   * @a default_editable indicates the editability of text that doesn't have a tag affecting editability applied to it.
   * Typically the result of Gtk::TextView::get_editable() is appropriate here.
   *
   * @param range_begin
   * @param range_end
   * @param default_editable Default editability of buffer
   * @result An iterator that points to the location where text was deleted, or end() is no text was deleted.
   */
  std::pair<iterator,bool> erase_interactive(const iterator& range_begin, const iterator& range_end, bool default_editable = true);
  
 
  iterator backspace(const iterator& iter, bool interactive = true, bool default_editable = true);
  
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  Glib::ustring get_text(const iterator& start, const iterator& end, bool include_hidden_chars =  true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  Glib::ustring get_text(const iterator& start, const iterator& end, bool include_hidden_chars =  true) const;
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  Glib::ustring get_text(bool include_hidden_chars = true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  Glib::ustring get_text(bool include_hidden_chars = true) const;
 
  
#ifndef GTKMM_DISABLE_DEPRECATED
 
  Glib::ustring get_slice(const iterator& start, const iterator& end, bool include_hidden_chars =  true);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  Glib::ustring get_slice(const iterator& start, const iterator& end, bool include_hidden_chars =  true) const;
 
  iterator insert_pixbuf(const iterator& pos, const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
  
 
  iterator insert_child_anchor(const iterator& pos, const Glib::RefPtr<ChildAnchor>& anchor);
  
 
  Glib::RefPtr<ChildAnchor> create_child_anchor(const iterator& pos);
  
 
  void add_mark(const Glib::RefPtr<TextBuffer::Mark>& mark, const iterator& where);
 
  
  Glib::RefPtr<TextBuffer::Mark> create_mark(const Glib::ustring& mark_name, const iterator& where, bool left_gravity =  true);
 
  Glib::RefPtr<Mark> create_mark(const iterator& where, bool left_gravity = true);
 
  
  void move_mark(const Glib::RefPtr<Mark>& mark, const iterator& where);
  
  void delete_mark(const Glib::RefPtr<Mark>& mark);
 
  
  Glib::RefPtr<TextBuffer::Mark> get_mark(const Glib::ustring& name);
  
  Glib::RefPtr<const TextBuffer::Mark> get_mark(const Glib::ustring& name) const;
 
  
  void move_mark_by_name(const Glib::ustring& name, const iterator& where);
  
  void delete_mark_by_name(const Glib::ustring& name);
 
  
  Glib::RefPtr<TextBuffer::Mark> get_insert();
  
  Glib::RefPtr<TextBuffer::Mark> get_selection_bound();
 
  
  void place_cursor(const iterator& where);
  
  void apply_tag(const Glib::RefPtr<Tag>& tag, const iterator& start, const iterator& end);
  
  void remove_tag(const Glib::RefPtr<Tag>& tag, const iterator& start, const iterator& end);
  
  void apply_tag_by_name(const Glib::ustring& name, const iterator& start, const iterator& end);
  
  void remove_tag_by_name(const Glib::ustring& name, const iterator& start, const iterator& end);
  
  void remove_all_tags(const iterator& start, const iterator& end);
 
  Glib::RefPtr<Tag> create_tag(const Glib::ustring& tag_name);
  
 
  Glib::RefPtr<Tag> create_tag();
 
  iterator get_iter_at_line_offset(int line_number, int char_offset);
  iterator get_iter_at_line_index(int line_number, int byte_index);
  iterator get_iter_at_offset(int char_offset);
  iterator get_iter_at_line(int line_number);
  iterator begin();
  iterator end();
  void get_bounds(iterator& range_begin, iterator& range_end);
 
  iterator get_iter_at_mark(const Glib::RefPtr<Mark>& mark);
 
  iterator get_iter_at_child_anchor(const Glib::RefPtr<ChildAnchor>& anchor);
 
  
  bool get_modified() const;
  
  void set_modified(bool setting =  true);
 
  
  bool get_has_selection() const;
 
  
  void add_selection_clipboard(const Glib::RefPtr<Clipboard>& clipboard);
  
  void remove_selection_clipboard(const Glib::RefPtr<Clipboard>& clipboard);
  
  void cut_clipboard(const Glib::RefPtr<Clipboard>& clipboard, bool default_editable =  true);
  
  void copy_clipboard(const Glib::RefPtr<Clipboard>& clipboard);
  void paste_clipboard(const Glib::RefPtr<Clipboard>& clipboard, const iterator& override_location, bool default_editable = true);
  void paste_clipboard(const Glib::RefPtr<Clipboard>& clipboard, bool default_editable = true);
  
 
  bool get_selection_bounds(iterator& start, iterator& end) const;
  
  bool erase_selection(bool interactive =  true, bool default_editable =  true);
 
  
  void select_range(const iterator& ins, const iterator& bound);
 
/* Called to specify atomic user actions, used to implement undo */
  
  void begin_user_action();
  
  void end_user_action();
 
  
  Glib::RefPtr<TargetList> get_copy_target_list() const;
  
  Glib::RefPtr<TargetList> get_paste_target_list() const;
 
//TODO: I have commented these out for now because I don't understand what the register_buffer and content_buffer are. murrayc.
 //TODO: Documentation.
 // typedef sigc::slot<guint8*, const Glib::RefPtr<TextBuffer>& /* content_buffer */, const iterator& /* start */, const iterator& /* end */, gsize& /* length */> SlotSerialize;
 
 
//TODO: Use ArrayHandle, or just use guint8* to be more efficient?
  // typedef sigc::slot<bool, const Glib::RefPtr<TextBuffer>& /* content_buffer */, iterator& /* iter */, const guint8*  /* data */, gsize /* length */, bool /* create_tags */> SlotDeserialize;
 
/*
  Glib::ustring register_serialize_format(const Glib::ustring& mime_type, const SlotSerialize& slot);
  _IGNORE(gtk_text_buffer_register_serialize_format)
*/
 
  
  Glib::ustring register_serialize_tagset(const Glib::ustring& tagset_name);
 
/*
  Glib::ustring register_deserialize_format(const Glib::ustring& mime_type, const SlotDeserialize& slot);
  _IGNORE(gtk_text_buffer_register_deserialize_format)
*/
  
  Glib::ustring register_deserialize_tagset(const Glib::ustring& tagset_name);
 
  
  void unregister_serialize_format(const Glib::ustring& format);
  
  void unregister_deserialize_format(const Glib::ustring& format);
 
  
  void set_can_create_tags(const Glib::ustring& format, bool can_create_tags =  true);
  
  bool get_can_create_tags(const Glib::ustring& format) const;
 
 
  Glib::StringArrayHandle get_serialize_formats() const;
  
  Glib::StringArrayHandle get_deserialize_formats() const;
  
 
/*
//TODO: I have commented these out for now because I don't understand what the register_buffer and content_buffer are. murrayc.
 
//TODO: Use something other than gsize?
#m4 _CONVERSION(`const iterator&', `GtkTextIter*',`($3).gobj()')
  _WRAP_METHOD(guint8* serialize(const Glib::RefPtr<TextBuffer>& content_buffer,
                                                       const Glib::ustring& format,
                                                       const iterator& iterstart,
                                                       const iterator& iterend,
                                                       gsize& length), gtk_text_buffer_serialize)
 
//TODO: Is the bool superfluous?
//TODO: Use an ArrayHandle?
  _WRAP_METHOD(bool deserialize(const Glib::RefPtr<TextBuffer>& content_buffer,
                                                       const Glib::ustring& format,
                                                       const iterator& iter, const guint8* data,
                                                       gsize length), gtk_text_buffer_deserialize, errthrow)
*/
 
 
  Glib::SignalProxy3< void,const TextBuffer::iterator&,const Glib::ustring&,int > signal_insert();
 
 
  Glib::SignalProxy2< void,const TextBuffer::iterator&,const Glib::RefPtr<Gdk::Pixbuf>& > signal_insert_pixbuf();
 
  
  Glib::SignalProxy2< void,const TextBuffer::iterator&,const Glib::RefPtr<ChildAnchor>& > signal_insert_child_anchor();
 
 
  Glib::SignalProxy2< void,const TextBuffer::iterator&,const TextBuffer::iterator& > signal_erase();
 
 
  Glib::SignalProxy0< void > signal_changed();
 
  
  Glib::SignalProxy0< void > signal_modified_changed();
 
  
  Glib::SignalProxy2< void,const TextBuffer::iterator&,const Glib::RefPtr<TextBuffer::Mark>& > signal_mark_set();
 
  
  Glib::SignalProxy1< void,const Glib::RefPtr<TextBuffer::Mark>& > signal_mark_deleted();
 
  
  Glib::SignalProxy3< void,const Glib::RefPtr<TextBuffer::Tag>&,const TextBuffer::iterator&,const TextBuffer::iterator& > signal_apply_tag();
 
  
  Glib::SignalProxy3< void,const Glib::RefPtr<TextBuffer::Tag>&,const TextBuffer::iterator&,const TextBuffer::iterator& > signal_remove_tag();
 
  
  Glib::SignalProxy0< void > signal_begin_user_action();
 
  
  Glib::SignalProxy0< void > signal_end_user_action();
 
 
  //TODO: Remove no_default_handler when we can break ABI:
 
 
  Glib::SignalProxy1< void,const Glib::RefPtr<Gtk::Clipboard>& > signal_paste_done();
 
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TextBuffer::TagTable> > property_tag_table() const;
 
 
  Glib::PropertyProxy< Glib::ustring > property_text() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text() const;
 
  Glib::PropertyProxy_ReadOnly< bool > property_has_selection() const;
 
 
  Glib::PropertyProxy_ReadOnly< int > property_cursor_position() const;
 
 
  //TODO: Check the ref-counting/conversion for these: _WRAP_PROPERTY("copy-target-list", Glib::ListHandle< Glib::RefPtr<TargetList> >)
  //TODO: _WRAP_PROPERTY("paste-target-list", Glib::ListHandle< Glib::RefPtr<TargetList> >)
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_insert(const TextBuffer::iterator& pos, const Glib::ustring& text, int bytes);
  virtual void on_insert_pixbuf(const TextBuffer::iterator& pos, const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
  virtual void on_insert_child_anchor(const TextBuffer::iterator& pos, const Glib::RefPtr<ChildAnchor>& anchor);
  virtual void on_erase(const TextBuffer::iterator& start, const TextBuffer::iterator& end);
  virtual void on_changed();
  virtual void on_modified_changed();
  virtual void on_mark_set(const TextBuffer::iterator& location, const Glib::RefPtr<TextBuffer::Mark>& mark);
  virtual void on_mark_deleted(const Glib::RefPtr<TextBuffer::Mark>& mark);
  virtual void on_apply_tag(const Glib::RefPtr<TextBuffer::Tag>& tag, const TextBuffer::iterator& range_begin, const TextBuffer::iterator& range_end);
  virtual void on_remove_tag(const Glib::RefPtr<TextBuffer::Tag>& tag, const TextBuffer::iterator& range_begin, const TextBuffer::iterator& range_end);
  virtual void on_begin_user_action();
  virtual void on_end_user_action();
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::TextBuffer> wrap(GtkTextBuffer* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_TEXTBUFFER_H */