khtml::EditableLineIterator Class Reference

#include <khtml_caret_p.h>

Inheritance diagram for khtml::EditableLineIterator:

Public Member Functions
	EditableLineIterator (const LineIterator &it, bool fromEnd=false)
	EditableLineIterator ()
void	advance (bool toBegin)
EditableLineIterator &	operator++ ()
EditableLineIterator &	operator-- ()
Public Member Functions inherited from khtml::LineIterator
void	advance (bool toBegin)
bool	isOutside () const
bool	isOutsideEnd ()
LinearDocument *	linearDocument () const
bool	operator!= (const LineIterator &it) const
CaretBoxLine *	operator* () const
LineIterator &	operator++ ()
LineIterator &	operator-- ()
bool	operator== (const LineIterator &it) const

Protected Member Functions
bool	isEditable (LineIterator &it)
Protected Member Functions inherited from khtml::LineIterator
	LineIterator ()
	LineIterator (LinearDocument *l, DOM::NodeImpl *node, long offset)
void	nextBlock ()
void	prevBlock ()

Additional Inherited Members
Static Public Member Functions inherited from khtml::LineIterator
static CaretBoxIterator &	currentCaretBox ()
static long	currentModifiedOffset ()
Protected Attributes inherited from khtml::LineIterator
CaretBoxLine *	cbl
LinearDocument *	lines
Static Protected Attributes inherited from khtml::LineIterator
static CaretBoxIterator	currentBox
static long	currentOffset

Detailed Description

Iterates through the editable lines of a document.

This iterator, opposing to LineIterator, only regards editable lines. Additionally, this iterator enforces the caret advance policy.

The iterator can be compared to normal LineIterators, especially to LinearDocument::preBegin and LinearDocument::end

The line iterator becomes invalid when the associated LinearDocument object is destroyed.

Author

Leo Savernik

Definition at line 807 of file khtml_caret_p.h.

Constructor & Destructor Documentation

khtml::EditableLineIterator::EditableLineIterator ( const LineIterator &  it, bool  fromEnd = false  )

inline

Initializes a new iterator.

The iterator is set to the first following editable line or to the end if no editable line follows.

Parameters

it	a line iterator to initialize this from
fromEnd	true, traverse towards the beginning in search of an editable line

Definition at line 817 of file khtml_caret_p.h.

khtml::EditableLineIterator::EditableLineIterator ( )

inline

empty constructor.

Only use if you want to copy another iterator onto it later.

Definition at line 828 of file khtml_caret_p.h.

Member Function Documentation

void khtml::EditableLineIterator::advance

(

bool

toBegin

)

advances to the line to come.

Parameters

toBegin

true, move to previous line, false, move to next line.

Definition at line 1688 of file khtml_caret.cpp.

bool khtml::EditableLineIterator::isEditable ( LineIterator &  it )

inlineprotected

finds out if the current line is editable.

Parameters

it	check caret box line iterator points to

Returns

true if line is editable

Definition at line 853 of file khtml_caret_p.h.

EditableLineIterator& khtml::EditableLineIterator::operator++ ( )

inline

seek next line

Guaranteed to crash if beyond beginning/end of document.

Definition at line 834 of file khtml_caret_p.h.

EditableLineIterator& khtml::EditableLineIterator::operator-- ( )

inline

seek previous line.

Guaranteed to crash if beyond beginning/end of document.

Definition at line 840 of file khtml_caret_p.h.

---

The documentation for this class was generated from the following files:

• khtml_caret_p.h
• khtml_caret.cpp