logo top
Main Page   Widgets   Namespaces   Book  

Gtk::TextIter Class Reference
[TextView Classes]

You can iterate over characters, words, lines, and sentences, but operator*() and operator++() deal in characters. More...

List of all members.

Public Types

typedef std::bidirectional_iterator_tag iterator_category
typedef gunichar value_type
typedef int difference_type
typedef value_type reference
typedef void pointer

Public Member Functions

 TextIter ()
 TextIter (const GtkTextIter* gobject)
GtkTextIter* gobj ()
 Provides access to the underlying C instance.

const GtkTextIter* gobj () const
 Provides access to the underlying C instance.

TextIteroperator++ ()
 Alias for forward_char().

const TextIter operator++ (int)
TextIteroperator-- ()
 Alias for backward_char().

const TextIter operator-- (int)
value_type operator* () const
 Alias for get_char().

 operator bool () const
 Alias for !is_end().

Glib::RefPtr<TextBufferget_buffer () const
int get_offset () const
int get_line () const
int get_line_offset () const
int get_line_index () const
int get_visible_line_offset () const
int get_visible_line_index () const
gunichar get_char () const
Glib::ustring get_slice (const TextIter& end) const
Glib::ustring get_text (const TextIter& end) const
Glib::ustring get_visible_slice (const TextIter& end) const
Glib::ustring get_visible_text (const TextIter& end) const
Glib::RefPtr<Gdk::Pixbufget_pixbuf () const
Glib::SListHandle< Glib::RefPtr<
TextMark > > 
get_marks () const
Glib::RefPtr<TextChildAnchorget_child_anchor () const
Glib::SListHandle< Glib::RefPtr<
TextTag > > 
get_toggled_tags (bool toggled_on=true) const
bool begins_tag (const Glib::RefPtr<TextTag>& tag) const
bool ends_tag (const Glib::RefPtr<TextTag>& tag) const
bool toggles_tag (const Glib::RefPtr<TextTag>& tag) const
bool has_tag (const Glib::RefPtr<TextTag>& tag) const
Glib::SListHandle< Glib::RefPtr<
TextTag > > 
get_tags () const
bool editable (bool default_setting=true) const
bool can_insert (bool default_editability=true) const
bool starts_word () const
bool ends_word () const
bool inside_word () const
bool starts_sentence () const
bool ends_sentence () const
bool inside_sentence () const
bool starts_line () const
bool ends_line () const
bool is_cursor_position () const
int get_chars_in_line () const
int get_bytes_in_line () const
bool get_attributes (TextAttributes& values) const
Pango::Language get_language () const
bool is_end () const
bool is_start () const
bool forward_char ()
bool backward_char ()
bool forward_chars (int count)
bool backward_chars (int count)
bool forward_line ()
bool backward_line ()
bool forward_lines (int count)
bool backward_lines (int count)
bool forward_word_end ()
bool backward_word_start ()
bool forward_word_ends (int count)
bool backward_word_starts (int count)
bool forward_visible_word_end ()
bool backward_visible_word_start ()
bool forward_visible_word_ends (int count)
bool backward_visible_word_starts (int count)
bool forward_sentence_end ()
bool backward_sentence_start ()
bool forward_sentence_ends (int count)
bool backward_sentence_starts (int count)
bool forward_cursor_position ()
bool backward_cursor_position ()
bool forward_cursor_positions (int count)
bool backward_cursor_positions (int count)
bool forward_visible_cursor_position ()
bool backward_visible_cursor_position ()
bool forward_visible_cursor_positions (int count)
bool backward_visible_cursor_positions (int count)
void set_offset (int char_offset)
void set_line (int line_number)
void set_line_offset (int char_on_line)
void set_line_index (int byte_on_line)
void forward_to_end ()
bool forward_to_line_end ()
void set_visible_line_offset (int char_on_line)
void set_visible_line_index (int byte_on_line)
bool forward_to_tag_toggle (const Glib::RefPtr<TextTag>& tag)
bool backward_to_tag_toggle (const Glib::RefPtr<TextTag>& tag)
template <class Predicate> bool forward_find_char (const Predicate& predicate, const TextIter& limit)
template <class Predicate> bool forward_find_char (const Predicate& predicate)
template <class Predicate> bool backward_find_char (const Predicate& predicate, const TextIter& limit)
template <class Predicate> bool backward_find_char (const Predicate& predicate)
bool forward_search (const Glib::ustring& str, TextSearchFlags flags, TextIter& match_start, TextIter& match_end, const TextIter& limit) const
bool backward_search (const Glib::ustring& str, TextSearchFlags flags, TextIter& match_start, TextIter& match_end, const TextIter& limit) const
int compare (const TextIter& rhs) const
bool in_range (const TextIter& start, const TextIter& end) const
void order (TextIter& second)

Protected Attributes

GtkTextIter gobject_

Related Functions

(Note that these are not member functions.)

bool operator== (const TextIter& lhs, const TextIter& rhs)
bool operator!= (const TextIter& lhs, const TextIter& rhs)
bool operator< (const TextIter& lhs, const TextIter& rhs)
bool operator> (const TextIter& lhs, const TextIter& rhs)
bool operator<= (const TextIter& lhs, const TextIter& rhs)
bool operator>= (const TextIter& lhs, const TextIter& rhs)
Gtk::TextIterwrap (GtkTextIter* object)
const Gtk::TextIterwrap (const GtkTextIter* object)


Detailed Description

You can iterate over characters, words, lines, and sentences, but operator*() and operator++() deal in characters.

TODO: Maybe we should have separate iterators for words, lines, and sentences.


Member Typedef Documentation

typedef int Gtk::TextIter::difference_type
 

typedef std::bidirectional_iterator_tag Gtk::TextIter::iterator_category
 

typedef void Gtk::TextIter::pointer
 

typedef value_type Gtk::TextIter::reference
 

typedef gunichar Gtk::TextIter::value_type
 


Constructor & Destructor Documentation

Gtk::TextIter::TextIter (  ) 
 

Gtk::TextIter::TextIter ( const GtkTextIter*  gobject  )  [explicit]
 


Member Function Documentation

bool Gtk::TextIter::backward_char (  ) 
 

bool Gtk::TextIter::backward_chars ( int  count  ) 
 

bool Gtk::TextIter::backward_cursor_position (  ) 
 

bool Gtk::TextIter::backward_cursor_positions ( int  count  ) 
 

template <class Predicate>
bool Gtk::TextIter::backward_find_char ( const Predicate&  predicate  ) 
 

template <class Predicate>
bool Gtk::TextIter::backward_find_char ( const Predicate&  predicate,
const TextIter limit
 

bool Gtk::TextIter::backward_line (  ) 
 

bool Gtk::TextIter::backward_lines ( int  count  ) 
 

bool Gtk::TextIter::backward_search ( const Glib::ustring str,
TextSearchFlags  flags,
TextIter match_start,
TextIter match_end,
const TextIter limit
const
 

bool Gtk::TextIter::backward_sentence_start (  ) 
 

bool Gtk::TextIter::backward_sentence_starts ( int  count  ) 
 

bool Gtk::TextIter::backward_to_tag_toggle ( const Glib::RefPtr<TextTag>&  tag  ) 
 

bool Gtk::TextIter::backward_visible_cursor_position (  ) 
 

bool Gtk::TextIter::backward_visible_cursor_positions ( int  count  ) 
 

bool Gtk::TextIter::backward_visible_word_start (  ) 
 

bool Gtk::TextIter::backward_visible_word_starts ( int  count  ) 
 

bool Gtk::TextIter::backward_word_start (  ) 
 

bool Gtk::TextIter::backward_word_starts ( int  count  ) 
 

bool Gtk::TextIter::begins_tag ( const Glib::RefPtr<TextTag>&  tag  )  const
 

bool Gtk::TextIter::can_insert ( bool  default_editability = true  )  const
 

int Gtk::TextIter::compare ( const TextIter rhs  )  const
 

bool Gtk::TextIter::editable ( bool  default_setting = true  )  const
 

bool Gtk::TextIter::ends_line (  )  const
 

bool Gtk::TextIter::ends_sentence (  )  const
 

bool Gtk::TextIter::ends_tag ( const Glib::RefPtr<TextTag>&  tag  )  const
 

bool Gtk::TextIter::ends_word (  )  const
 

bool Gtk::TextIter::forward_char (  ) 
 

bool Gtk::TextIter::forward_chars ( int  count  ) 
 

bool Gtk::TextIter::forward_cursor_position (  ) 
 

bool Gtk::TextIter::forward_cursor_positions ( int  count  ) 
 

template <class Predicate>
bool Gtk::TextIter::forward_find_char ( const Predicate&  predicate  ) 
 

template <class Predicate>
bool Gtk::TextIter::forward_find_char ( const Predicate&  predicate,
const TextIter limit
 

bool Gtk::TextIter::forward_line (  ) 
 

bool Gtk::TextIter::forward_lines ( int  count  ) 
 

bool Gtk::TextIter::forward_search ( const Glib::ustring str,
TextSearchFlags  flags,
TextIter match_start,
TextIter match_end,
const TextIter limit
const
 

bool Gtk::TextIter::forward_sentence_end (  ) 
 

bool Gtk::TextIter::forward_sentence_ends ( int  count  ) 
 

void Gtk::TextIter::forward_to_end (  ) 
 

bool Gtk::TextIter::forward_to_line_end (  ) 
 

bool Gtk::TextIter::forward_to_tag_toggle ( const Glib::RefPtr<TextTag>&  tag  ) 
 

bool Gtk::TextIter::forward_visible_cursor_position (  ) 
 

bool Gtk::TextIter::forward_visible_cursor_positions ( int  count  ) 
 

bool Gtk::TextIter::forward_visible_word_end (  ) 
 

bool Gtk::TextIter::forward_visible_word_ends ( int  count  ) 
 

bool Gtk::TextIter::forward_word_end (  ) 
 

bool Gtk::TextIter::forward_word_ends ( int  count  ) 
 

bool Gtk::TextIter::get_attributes ( TextAttributes values  )  const
 

Glib::RefPtr<TextBuffer> Gtk::TextIter::get_buffer (  )  const
 

int Gtk::TextIter::get_bytes_in_line (  )  const
 

gunichar Gtk::TextIter::get_char (  )  const
 

int Gtk::TextIter::get_chars_in_line (  )  const
 

Glib::RefPtr<TextChildAnchor> Gtk::TextIter::get_child_anchor (  )  const
 

Pango::Language Gtk::TextIter::get_language (  )  const
 

int Gtk::TextIter::get_line (  )  const
 

int Gtk::TextIter::get_line_index (  )  const
 

int Gtk::TextIter::get_line_offset (  )  const
 

Glib::SListHandle<Glib::RefPtr<TextMark>> Gtk::TextIter::get_marks (  )  const
 

int Gtk::TextIter::get_offset (  )  const
 

Glib::RefPtr<Gdk::Pixbuf> Gtk::TextIter::get_pixbuf (  )  const
 

Glib::ustring Gtk::TextIter::get_slice ( const TextIter end  )  const
 

Glib::SListHandle<Glib::RefPtr<TextTag>> Gtk::TextIter::get_tags (  )  const
 

Glib::ustring Gtk::TextIter::get_text ( const TextIter end  )  const
 

Glib::SListHandle<Glib::RefPtr<TextTag>> Gtk::TextIter::get_toggled_tags ( bool  toggled_on = true  )  const
 

int Gtk::TextIter::get_visible_line_index (  )  const
 

int Gtk::TextIter::get_visible_line_offset (  )  const
 

Glib::ustring Gtk::TextIter::get_visible_slice ( const TextIter end  )  const
 

Glib::ustring Gtk::TextIter::get_visible_text ( const TextIter end  )  const
 

const GtkTextIter* Gtk::TextIter::gobj (  )  const [inline]
 

Provides access to the underlying C instance.

GtkTextIter* Gtk::TextIter::gobj (  )  [inline]
 

Provides access to the underlying C instance.

bool Gtk::TextIter::has_tag ( const Glib::RefPtr<TextTag>&  tag  )  const
 

bool Gtk::TextIter::in_range ( const TextIter start,
const TextIter end
const
 

bool Gtk::TextIter::inside_sentence (  )  const
 

bool Gtk::TextIter::inside_word (  )  const
 

bool Gtk::TextIter::is_cursor_position (  )  const
 

bool Gtk::TextIter::is_end (  )  const
 

bool Gtk::TextIter::is_start (  )  const
 

value_type Gtk::TextIter::operator* (  )  const [inline]
 

Alias for get_char().

Gtk::TextIter::operator bool (  )  const [inline]
 

Alias for !is_end().

const TextIter Gtk::TextIter::operator++ ( int   )  [inline]
 

TextIter& Gtk::TextIter::operator++ (  )  [inline]
 

Alias for forward_char().

const TextIter Gtk::TextIter::operator-- ( int   )  [inline]
 

TextIter& Gtk::TextIter::operator-- (  )  [inline]
 

Alias for backward_char().

void Gtk::TextIter::order ( TextIter second  ) 
 

void Gtk::TextIter::set_line ( int  line_number  ) 
 

void Gtk::TextIter::set_line_index ( int  byte_on_line  ) 
 

void Gtk::TextIter::set_line_offset ( int  char_on_line  ) 
 

void Gtk::TextIter::set_offset ( int  char_offset  ) 
 

void Gtk::TextIter::set_visible_line_index ( int  byte_on_line  ) 
 

void Gtk::TextIter::set_visible_line_offset ( int  char_on_line  ) 
 

bool Gtk::TextIter::starts_line (  )  const
 

bool Gtk::TextIter::starts_sentence (  )  const
 

bool Gtk::TextIter::starts_word (  )  const
 

bool Gtk::TextIter::toggles_tag ( const Glib::RefPtr<TextTag>&  tag  )  const
 


Friends And Related Function Documentation

bool operator!= ( const TextIter lhs,
const TextIter rhs
[related]
 

bool operator< ( const TextIter lhs,
const TextIter rhs
[related]
 

bool operator<= ( const TextIter lhs,
const TextIter rhs
[related]
 

bool operator== ( const TextIter lhs,
const TextIter rhs
[related]
 

bool operator> ( const TextIter lhs,
const TextIter rhs
[related]
 

bool operator>= ( const TextIter lhs,
const TextIter rhs
[related]
 

const Gtk::TextIter& wrap ( const GtkTextIter*  object  )  [related]
 

Gtk::TextIter& wrap ( GtkTextIter*  object  )  [related]
 


Member Data Documentation

GtkTextIter Gtk::TextIter::gobject_ [protected]
 


The documentation for this class was generated from the following file:
Generated for gtkmm 2.2 by Doxygen 1.3.4 © 1997-2001