khtml::CaretBox Class Reference

Represents a rectangular box within which the caret is located. More...

#include <khtml_caret_p.h>

List of all members.

Public Member Functions
	CaretBox ()
	CaretBox (InlineBox *ibox, bool outside, bool outsideEnd)
	CaretBox (int x, int y, int w, int h, RenderBox *cb, bool outside, bool outsideEnd)
RenderBlock *	containingBlock () const
RenderBox *	enclosingObject () const
int	height () const
InlineBox *	inlineBox () const
bool	isInline () const
bool	isInlineTextBox () const
bool	isLineBreak () const
bool	isOutside () const
bool	isOutsideEnd () const
long	maxOffset () const
long	minOffset () const
RenderObject *	object () const
int	width () const
int	xPos () const
int	yPos () const
Protected Attributes
InlineBox *	_box
int	_h
bool	_outside:1
short	_w
int	_x
int	_y
RenderBox *	cb
bool	outside_end:1

---

Detailed Description

Represents a rectangular box within which the caret is located.

The caret box serves as a wrapper for inline boxes of all kind. It either wraps an InlineBox, InlineTextBox, or InlineFlowBox, or if no such boxes exist for a certain context, it contains the relevant information directly.

This class will be constructed whenever a caret position has to be described.

Author:

Leo Savernik

Definition at line 126 of file khtml_caret_p.h.

---

Constructor & Destructor Documentation

khtml::CaretBox::CaretBox

(

)

[inline]

empty constructor for later assignment

Definition at line 140 of file khtml_caret_p.h.

khtml::CaretBox::CaretBox	(	InlineBox *	ibox,
		bool	outside,
		bool	outsideEnd
	)		[inline]

initializes the caret box from the given inline box

Definition at line 142 of file khtml_caret_p.h.

khtml::CaretBox::CaretBox	(	int	x,
		int	y,
		int	w,
		int	h,
		RenderBox *	cb,
		bool	outside,
		bool	outsideEnd
	)		[inline]

initializes the caret box from scratch

Definition at line 150 of file khtml_caret_p.h.

---

Member Function Documentation

RenderBlock* khtml::CaretBox::containingBlock

(

)

const [inline]

returns the containing block of this caret box.

If the caret box resembles a block itself, its containing block is returned.

Definition at line 165 of file khtml_caret_p.h.

RenderBox* khtml::CaretBox::enclosingObject

(

)

const [inline]

Definition at line 159 of file khtml_caret_p.h.

int khtml::CaretBox::height

(

)

const [inline]

Definition at line 156 of file khtml_caret_p.h.

InlineBox* khtml::CaretBox::inlineBox

(

)

const [inline]

Definition at line 160 of file khtml_caret_p.h.

bool khtml::CaretBox::isInline

(

)

const [inline]

returns the replaced render object if this caret box represents one, 0 otherwise.

returns true if this caret box represents an inline element, or text box, otherwise false.

Definition at line 175 of file khtml_caret_p.h.

bool khtml::CaretBox::isInlineTextBox

(

)

const [inline]

returns true if this caret box represents an inline text box.

Definition at line 178 of file khtml_caret_p.h.

bool khtml::CaretBox::isLineBreak

(

)

const [inline]

returns true if this caret box represents a line break

Definition at line 181 of file khtml_caret_p.h.

bool khtml::CaretBox::isOutside

(

)

const [inline]

returns true when this caret box represents an ouside position of an element.

Definition at line 188 of file khtml_caret_p.h.

bool khtml::CaretBox::isOutsideEnd

(

)

const [inline]

returns the position at which the outside is targeted at.

This method's return value is meaningless if isOutside() is not true.

Returns:

true if the outside end is meant, false if the outside beginning is meant.

Definition at line 195 of file khtml_caret_p.h.

long khtml::CaretBox::maxOffset

(

)

const [inline]

returns the maximum offset for this caret box.

Definition at line 204 of file khtml_caret_p.h.

long khtml::CaretBox::minOffset

(

)

const [inline]

returns the minimum offset for this caret box.

Definition at line 201 of file khtml_caret_p.h.

RenderObject* khtml::CaretBox::object

(

)

const [inline]

returns the associated render object.

Definition at line 197 of file khtml_caret_p.h.

int khtml::CaretBox::width

(

)

const [inline]

Definition at line 155 of file khtml_caret_p.h.

int khtml::CaretBox::xPos

(

)

const [inline]

Definition at line 157 of file khtml_caret_p.h.

int khtml::CaretBox::yPos

(

)

const [inline]

Definition at line 158 of file khtml_caret_p.h.

---

Member Data Documentation

InlineBox* khtml::CaretBox::_box [protected]

Definition at line 128 of file khtml_caret_p.h.

int khtml::CaretBox::_h [protected]

Definition at line 130 of file khtml_caret_p.h.

bool khtml::CaretBox::_outside [protected]

Definition at line 134 of file khtml_caret_p.h.

short khtml::CaretBox::_w [protected]

Definition at line 129 of file khtml_caret_p.h.

int khtml::CaretBox::_x [protected]

Definition at line 131 of file khtml_caret_p.h.

int khtml::CaretBox::_y [protected]

Definition at line 132 of file khtml_caret_p.h.

RenderBox* khtml::CaretBox::cb [protected]

Definition at line 133 of file khtml_caret_p.h.

bool khtml::CaretBox::outside_end [protected]

Definition at line 135 of file khtml_caret_p.h.

---

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

• khtml_caret_p.h