textview.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TEXTVIEW_H
#define _GTKMM_TEXTVIEW_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: textview.hg,v 1.10 2006/04/12 11:11:25 murrayc Exp $ */
 
/* Copyright(C) 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/container.h>
#include <gtkmm/textbuffer.h>
#include <gtkmm/textmark.h>
#include <gtkmm/menu.h>
#include <gtkmm/adjustment.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTextView GtkTextView;
typedef struct _GtkTextViewClass GtkTextViewClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class TextView_Class; } // namespace Gtk
namespace Gtk
{
 
 
enum TextWindowType
{
  TEXT_WINDOW_PRIVATE,
  TEXT_WINDOW_WIDGET,
  TEXT_WINDOW_TEXT,
  TEXT_WINDOW_LEFT,
  TEXT_WINDOW_RIGHT,
  TEXT_WINDOW_TOP,
  TEXT_WINDOW_BOTTOM
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::TextWindowType> : public Glib::Value_Enum<Gtk::TextWindowType>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class TextView : public Container
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef TextView CppObjectType;
  typedef TextView_Class CppClassType;
  typedef GtkTextView BaseObjectType;
  typedef GtkTextViewClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~TextView();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class TextView_Class;
  static CppClassType textview_class_;
 
  // noncopyable
  TextView(const TextView&);
  TextView& operator=(const TextView&);
 
protected:
  explicit TextView(const Glib::ConstructParams& construct_params);
  explicit TextView(GtkTextView* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkTextView*       gobj()       { return reinterpret_cast<GtkTextView*>(gobject_); }
 
  const GtkTextView* gobj() const { return reinterpret_cast<GtkTextView*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_set_scroll_adjustments(Adjustment* hadjustment, Adjustment* vadjustment);
  virtual void on_populate_popup(Menu* menu);
  virtual void on_set_anchor();
  virtual void on_insert_at_cursor(const Glib::ustring& str);
 
 
private:
 
public:
  TextView();
  explicit TextView(const Glib::RefPtr<TextBuffer>& buffer);
 
  
  void set_buffer(const Glib::RefPtr<TextBuffer>& buffer);
  
  Glib::RefPtr<TextBuffer> get_buffer();
  
  Glib::RefPtr<const TextBuffer> get_buffer() const;
 
  #ifndef GTKMM_DISABLE_DEPRECATED
 
  bool scroll_to_iter(TextBuffer::iterator& iter, double within_margin);
 
  void scroll_to_mark(const Glib::RefPtr<TextBuffer::Mark>& mark, double within_margin);
 
  void scroll_mark_onscreen(const Glib::RefPtr<TextBuffer::Mark>& mark);
  #endif // GTKMM_DISABLE_DEPRECATED
 
 
  bool scroll_to(TextBuffer::iterator& iter, double within_margin = 0);
 
  bool scroll_to(TextBuffer::iterator& iter, double within_margin, double xalign, double yalign);
  
 
  void scroll_to(const Glib::RefPtr<TextBuffer::Mark>& mark, double within_margin = 0);
 
  void scroll_to(const Glib::RefPtr<TextBuffer::Mark>& mark, double within_margin, double xalign, double yalign);
  
 
   //It does not do anything more than the default scroll_to(mark).
 
  
  bool move_mark_onscreen(const Glib::RefPtr<TextBuffer::Mark>& mark);
  
  bool place_cursor_onscreen();
 
  
  void get_visible_rect(Gdk::Rectangle& visible_rect) const;
  
  void set_cursor_visible(bool setting =  true);
  
  bool get_cursor_visible() const;
 
  
  void get_iter_location(const TextBuffer::iterator& iter, Gdk::Rectangle& location) const;
  
  void get_iter_at_location(TextBuffer::iterator& iter, int x, int y) const;
  
  void get_iter_at_position(TextBuffer::iterator& iter, int& trailing, int x, int y) const;
  
  void get_line_yrange(const TextBuffer::iterator& iter, int& y, int& height) const;
 
  
  void get_line_at_y(TextBuffer::iterator& target_iter, int y, int& line_top) const;
 
  
  void buffer_to_window_coords(TextWindowType win, int buffer_x, int buffer_y, int& window_x, int& window_y) const;
  
  void window_to_buffer_coords(TextWindowType win, int window_x, int window_y, int& buffer_x, int& buffer_y) const;
 
  
  Gtk::Adjustment* get_hadjustment();
  
  const Gtk::Adjustment* get_hadjustment() const;
  
  Gtk::Adjustment* get_vadjustment();
  
  const Gtk::Adjustment* get_vadjustment() const;
 
  
  Glib::RefPtr<Gdk::Window> get_window(TextWindowType win);
  
  Glib::RefPtr<const Gdk::Window> get_window(TextWindowType win) const;
  
  TextWindowType get_window_type(const Glib::RefPtr<Gdk::Window>& window);
 
  
  void set_border_window_size(TextWindowType type, int size);
  
  int get_border_window_size(TextWindowType type) const;
 
  
  bool forward_display_line(TextBuffer::iterator& iter);
  
  bool backward_display_line(TextBuffer::iterator& iter);
  
  bool forward_display_line_end(TextBuffer::iterator& iter);
  
  bool backward_display_line_start(TextBuffer::iterator& iter);
  
  bool starts_display_line(const TextBuffer::iterator& iter);
  
  bool move_visually(TextBuffer::iterator& iter, int count);
 
  
  bool im_context_filter_keypress(GdkEventKey* event);
  
  void reset_im_context();
 
  
  void add_child_at_anchor(Widget& child, const Glib::RefPtr<TextBuffer::ChildAnchor>& anchor);
 
  
  void add_child_in_window(Widget& child, TextWindowType which_window, int xpos, int ypos);
 
  
  void move_child(Widget& child, int xpos, int ypos);
 
  
  void set_wrap_mode(WrapMode wrap_mode);
  
  WrapMode get_wrap_mode() const;
  
  void set_editable(bool setting =  true);
  
  bool get_editable() const;
  
  void set_pixels_above_lines(int pixels_above_lines);
  
  int get_pixels_above_lines() const;
  
  void set_pixels_below_lines(int pixels_below_lines);
  
  int get_pixels_below_lines() const;
  
  void set_pixels_inside_wrap(int pixels_inside_wrap);
  
  int get_pixels_inside_wrap() const;
  
  void set_justification(Justification justification);
  
  Justification get_justification() const;
  
  void set_left_margin(int left_margin);
  
  int get_left_margin() const;
  
  void set_right_margin(int right_margin);
  
  int get_right_margin() const;
  
  void set_indent(int indent);
  
  int get_indent() const;
  
  void set_tabs(Pango::TabArray& tabs);
  
  Pango::TabArray get_tabs() const;
  
  TextAttributes get_default_attributes() const;
 
  
  void set_overwrite(bool overwrite =  true);
  
  bool get_overwrite() const;
 
  
  void set_accepts_tab(bool accepts_tab =  true);
  
  bool get_accepts_tab() const;
 
  
  Glib::SignalProxy2< void,Adjustment*,Adjustment* > signal_set_scroll_adjustments();
 
  
  Glib::SignalProxy1< void,Menu* > signal_populate_popup();
 
 
  Glib::SignalProxy0< void > signal_set_anchor();
 
 
  Glib::SignalProxy1< void,const Glib::ustring& > signal_insert_at_cursor();
 
 
  //Keybinding signals:
  
  
  //gtkmmproc error: move_focus : ignored signal defs lookup failed
  
  
  Glib::PropertyProxy< int > property_pixels_above_lines() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_pixels_above_lines() const;
 
  Glib::PropertyProxy< int > property_pixels_below_lines() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_pixels_below_lines() const;
 
  Glib::PropertyProxy< int > property_pixels_inside_wrap() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_pixels_inside_wrap() const;
 
  Glib::PropertyProxy< bool > property_editable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_editable() const;
 
  Glib::PropertyProxy< WrapMode > property_wrap_mode() ;
 
  Glib::PropertyProxy_ReadOnly< WrapMode > property_wrap_mode() const;
 
  Glib::PropertyProxy< Justification > property_justification() ;
 
  Glib::PropertyProxy_ReadOnly< Justification > property_justification() const;
 
  Glib::PropertyProxy< int > property_left_margin() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_left_margin() const;
 
  Glib::PropertyProxy< int > property_right_margin() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_right_margin() const;
 
  Glib::PropertyProxy< int > property_indent() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_indent() const;
 
  Glib::PropertyProxy< Pango::TabArray > property_tabs() ;
 
  Glib::PropertyProxy_ReadOnly< Pango::TabArray > property_tabs() const;
 
  Glib::PropertyProxy< bool > property_cursor_visible() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_cursor_visible() const;
 
  Glib::PropertyProxy< Glib::RefPtr<TextBuffer> > property_buffer() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TextBuffer> > property_buffer() const;
 
  Glib::PropertyProxy< bool > property_overwrite() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_overwrite() const;
 
  Glib::PropertyProxy< bool > property_accepts_tab() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_accepts_tab() const;
 
  Glib::PropertyProxy< Glib::ustring > property_im_module() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_im_module() const;
 
 
};
 
} /* namespace Gtk */
 
 
namespace Glib
{
  Gtk::TextView* wrap(GtkTextView* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_TEXTVIEW_H */