• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KHTML

  • khtml
  • EditableLineIterator
Public Member Functions | Protected Member Functions
khtml::EditableLineIterator Class Reference

#include <khtml_caret_p.h>

Inheritance diagram for khtml::EditableLineIterator:
khtml::LineIterator khtml::ErgonomicEditableLineIterator

List of all members.

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
bool isOutside () const
bool isOutsideEnd ()
LinearDocument * linearDocument () const
bool operator!= (const LineIterator &it) const
CaretBoxLine * operator* () const
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:
ita line iterator to initialize this from
fromEndtrue, 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:
toBegintrue, move to previous line, false, move to next line.

Reimplemented from khtml::LineIterator.

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:
itcheck 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.

Reimplemented from khtml::LineIterator.

Reimplemented in khtml::ErgonomicEditableLineIterator.

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.

Reimplemented from khtml::LineIterator.

Reimplemented in khtml::ErgonomicEditableLineIterator.

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 11:51:13 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KHTML

Skip menu "KHTML"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal