KHTML
#include <khtml_caret_p.h>
Public Types | |
typedef LineIterator | Iterator |
Public Member Functions | |
LinearDocument (KHTMLPart *part, DOM::NodeImpl *node, long offset, CaretAdvancePolicy advancePolicy, DOM::ElementImpl *baseElem) | |
virtual | ~LinearDocument () |
CaretAdvancePolicy | advancePolicy () const |
RenderObject * | baseObject () const |
Iterator | begin () |
int | count () const |
Iterator | current () |
const Iterator & | end () const |
bool | isValid () const |
const Iterator & | preBegin () const |
Iterator | preEnd () |
Protected Member Functions | |
void | initEndIterator () |
void | initPreBeginIterator () |
Protected Attributes | |
Iterator | _end |
Iterator | _preBegin |
CaretAdvancePolicy | advPol |
RenderObject * | base |
CaretBoxLineDeleter | cblDeleter |
KHTMLPart * | m_part |
DOM::NodeImpl * | node |
long | offset |
Detailed Description
Represents the whole document in terms of lines.
SGML documents are trees. But for navigation, this representation is not practical. Therefore this class serves as a helper to represent the document as a linear list of lines. Its usage somewhat resembles STL semantics like begin and end as well as iterators.
The lines itself are represented as caret line boxes.
LinearDocument instances are not meant to be kept over the lifetime of their associated document, but constructed from (node, offset) pairs whenever line traversal is needed. This is because the underlying InlineFlowBox objects may be destroyed and recreated (e. g. by resizing the window, adding/removing elements).
Definition at line 622 of file khtml_caret_p.h.
Member Typedef Documentation
Definition at line 624 of file khtml_caret_p.h.
Constructor & Destructor Documentation
khtml::LinearDocument::LinearDocument | ( | KHTMLPart * | part, |
DOM::NodeImpl * | node, | ||
long | offset, | ||
CaretAdvancePolicy | advancePolicy, | ||
DOM::ElementImpl * | baseElem | ||
) |
Creates a new instance, and initializes it to the line specified by the parameters below.
Creation will fail if node
is invisible or defect.
- Parameters
-
part part within which everything is taking place. node document node with which to start offset zero-based offset within this node. advancePolicy caret advance policy baseElem base element which the caret must not advance beyond (0 means whole document). The base element will be ignored if it cannot serve as a base (to see if this is the case, check whether LinearDocument::baseFlow()->element() != base)
Definition at line 1244 of file khtml_caret.cpp.
|
virtual |
Definition at line 1261 of file khtml_caret.cpp.
Member Function Documentation
|
inline |
Returns the current caret advance policy.
Definition at line 697 of file khtml_caret_p.h.
|
inline |
Returns the base render object which the caret must not advance beyond.
Note that HTML documents are usually restricted to the body element.
- Returns
- the base render object or 0 if the whole document is valid.
Definition at line 706 of file khtml_caret_p.h.
LinearDocument::Iterator khtml::LinearDocument::begin | ( | ) |
Returns a line iterator pointing to the very first line of the document.
Definition at line 1276 of file khtml_caret.cpp.
int khtml::LinearDocument::count | ( | ) | const |
Returns the count of lines.
Warning: This function is expensive. Call it once and cache the value.
FIXME: It's not implemented yet (and maybe never will)
Definition at line 1265 of file khtml_caret.cpp.
LinearDocument::Iterator khtml::LinearDocument::current | ( | ) |
Returns a line iterator containing the current position as its starting value.
Definition at line 1271 of file khtml_caret.cpp.
|
inline |
Returns a line iterator pointing right after the end of the document.
Definition at line 676 of file khtml_caret_p.h.
|
protected |
Definition at line 1309 of file khtml_caret.cpp.
|
protected |
Definition at line 1304 of file khtml_caret.cpp.
|
inline |
Tells whether this list contains any lines.
- Returns
true
if this document contains lines,false
otherwise. Note that an empty document contains at least one line, so this method only returnsfalse
if the document could not be initialised for some reason.
Definition at line 653 of file khtml_caret_p.h.
|
inline |
Returns a line iterator pointing just before the very first line of the document (this is somewhat an emulation of reverse iterators).
Definition at line 692 of file khtml_caret_p.h.
LinearDocument::Iterator khtml::LinearDocument::preEnd | ( | ) |
Returns a line iterator pointing to the very last line of the document.
Definition at line 1290 of file khtml_caret.cpp.
Member Data Documentation
|
protected |
Definition at line 718 of file khtml_caret_p.h.
|
protected |
Definition at line 717 of file khtml_caret_p.h.
|
protected |
Definition at line 721 of file khtml_caret_p.h.
|
protected |
Definition at line 722 of file khtml_caret_p.h.
|
protected |
Definition at line 713 of file khtml_caret_p.h.
|
protected |
Definition at line 720 of file khtml_caret_p.h.
|
protected |
Definition at line 714 of file khtml_caret_p.h.
|
protected |
Definition at line 715 of file khtml_caret_p.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:26:21 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.