#include <KoTextCustomItem.h>

Inheritance diagram for KoTextCustomItem:

Public Types
enum	Placement { PlaceInline = 0 , PlaceLeft , PlaceRight }

Public Member Functions
	KoTextCustomItem (KoTextDocument *p)

virtual void	draw (TQPainter *p, int x, int y, int cx, int cy, int cw, int ch, const TQColorGroup &cg, bool selected)

virtual void	finalize ()

void	move (int x, int y)

int	x () const

int	y () const

virtual void	setFormat (KoTextFormat *)

virtual Placement	placement () const

bool	placeInline ()

virtual bool	ownLine () const

virtual void	resize (int nwidth)

virtual void	invalidate ()

virtual bool	isNested () const

virtual int	minimumWidth () const

virtual int	widthHint () const

virtual int	ascent () const

virtual TQString	richText () const

TQRect	geometry () const

virtual bool	enter (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy, bool atEnd=false)

virtual bool	enterAt (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy, const TQPoint &)

virtual bool	next (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy)

virtual bool	prev (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy)

virtual bool	down (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy)

virtual bool	up (KoTextCursor , KoTextDocument &doc, KoTextParag *&parag, int &idx, int &ox, int &oy)

void	setParagraph (KoTextParag *p)

KoTextParag *	paragraph () const

virtual void	pageBreak (int, KoTextFlow *)

KoTextDocument *	textDocument () const

virtual void	setDeleted (bool b)

bool	isDeleted () const

virtual KCommand *	createCommand ()

virtual KCommand *	deleteCommand ()

virtual void	save (TQDomElement &formatElem)=0

virtual void	saveOasis (KoXmlWriter &writer, KoSavingContext &context) const =0

virtual int	typeId () const =0

virtual void	resize ()

virtual void	recalc ()

int	index () const

KoTextFormat *	format () const

virtual void	drawCustomItem (TQPainter *p, int x, int y, int wpix, int hpix, int ascentpix, int cx, int cy, int cw, int ch, const TQColorGroup &cg, bool selected, int offset, bool drawingShadow)=0

Public Attributes
int	width

int	height

KoTextDocument *	parent

Protected Attributes
bool	m_deleted

int	xpos

int	ypos

Detailed Description

KoTextCustomItem is the base class for custom items (i.e.

special chars) Custom items include:

variables ( KoVariable, kovariable.h )
in kword: inline images ( KWTextImage, kwtextimage.h ) (to be removed)
in kword: anchors, i.e. floating frames ( KWAnchor, kwanchor.h )

Definition at line 33 of file KoTextCustomItem.h.

Member Enumeration Documentation

◆ Placement

enum KoTextCustomItem::Placement

Definition at line 52 of file KoTextCustomItem.h.

Constructor & Destructor Documentation

◆ KoTextCustomItem()

KoTextCustomItem::KoTextCustomItem ( KoTextDocument * p )

Definition at line 1686 of file KoRichText.cpp.

◆ ~KoTextCustomItem()

KoTextCustomItem::~KoTextCustomItem ( )

virtual

Definition at line 1692 of file KoRichText.cpp.

Member Function Documentation

◆ ascent()

virtual int KoTextCustomItem::ascent ( ) const

inlinevirtual

Definition at line 64 of file KoTextCustomItem.h.

◆ createCommand()

virtual KCommand * KoTextCustomItem::createCommand ( )

inlinevirtual

Called when the item is created or 'deleted' by the user Most custom items don't need to reimplement those, since the custom item is simply moved into the undo/redo history when deleting (or undoing a creation).

It is not deleted and re-created later.

Definition at line 104 of file KoTextCustomItem.h.

◆ deleteCommand()

virtual KCommand * KoTextCustomItem::deleteCommand ( )

inlinevirtual

Definition at line 105 of file KoTextCustomItem.h.

◆ down()

bool KoTextCustomItem::down	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy
	)

virtual

Definition at line 49 of file KoTextCustomItem.cpp.

◆ draw()

void KoTextCustomItem::draw	(	TQPainter *	p,
		int	x,
		int	y,
		int	cx,
		int	cy,
		int	cw,
		int	ch,
		const TQColorGroup &	cg,
		bool	selected
	)

virtual

Definition at line 73 of file KoTextCustomItem.cpp.

◆ drawCustomItem()

virtual void KoTextCustomItem::drawCustomItem	(	TQPainter *	p,
		int	x,
		int	y,
		int	wpix,
		int	hpix,
		int	ascentpix,
		int	cx,
		int	cy,
		int	cw,
		int	ch,
		const TQColorGroup &	cg,
		bool	selected,
		int	offset,
		bool	drawingShadow
	)

pure virtual

All coordinates are in pixels.

Implemented in KoVariable.

◆ enter()

bool KoTextCustomItem::enter	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy,
		bool	atEnd = `false`
	)

virtual

Definition at line 32 of file KoTextCustomItem.cpp.

◆ enterAt()

bool KoTextCustomItem::enterAt	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy,
		const TQPoint &
	)

virtual

Definition at line 37 of file KoTextCustomItem.cpp.

◆ finalize()

virtual void KoTextCustomItem::finalize ( )

inlinevirtual

Definition at line 41 of file KoTextCustomItem.h.

◆ format()

KoTextFormat * KoTextCustomItem::format ( ) const

The formatting given to this 'special' character Slightly slow (does a linear search in the paragraph)

Definition at line 65 of file KoTextCustomItem.cpp.

◆ geometry()

TQRect KoTextCustomItem::geometry ( ) const

inline

Definition at line 71 of file KoTextCustomItem.h.

◆ index()

int KoTextCustomItem::index ( ) const

The index in paragraph(), where this anchor is Slightly slow (does a linear search in the paragraph)

Definition at line 58 of file KoTextCustomItem.cpp.

◆ invalidate()

virtual void KoTextCustomItem::invalidate ( )

inlinevirtual

Definition at line 59 of file KoTextCustomItem.h.

◆ isDeleted()

bool KoTextCustomItem::isDeleted ( ) const

inline

Definition at line 97 of file KoTextCustomItem.h.

◆ isNested()

virtual bool KoTextCustomItem::isNested ( ) const

inlinevirtual

Definition at line 61 of file KoTextCustomItem.h.

◆ minimumWidth()

virtual int KoTextCustomItem::minimumWidth ( ) const

inlinevirtual

Definition at line 62 of file KoTextCustomItem.h.

◆ move()

void KoTextCustomItem::move	(	int	x,
		int	y
	)

inline

Definition at line 43 of file KoTextCustomItem.h.

◆ next()

bool KoTextCustomItem::next	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy
	)

virtual

Definition at line 41 of file KoTextCustomItem.cpp.

◆ ownLine()

virtual bool KoTextCustomItem::ownLine ( ) const

inlinevirtual

Definition at line 56 of file KoTextCustomItem.h.

◆ pageBreak()

virtual void KoTextCustomItem::pageBreak	(	int	,
		KoTextFlow *
	)

inlinevirtual

Definition at line 83 of file KoTextCustomItem.h.

◆ paragraph()

KoTextParag * KoTextCustomItem::paragraph ( ) const

inline

Definition at line 81 of file KoTextCustomItem.h.

◆ placeInline()

bool KoTextCustomItem::placeInline ( )

inline

Definition at line 54 of file KoTextCustomItem.h.

◆ placement()

virtual Placement KoTextCustomItem::placement ( ) const

inlinevirtual

Definition at line 53 of file KoTextCustomItem.h.

◆ prev()

bool KoTextCustomItem::prev	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy
	)

virtual

Definition at line 45 of file KoTextCustomItem.cpp.

◆ recalc()

virtual void KoTextCustomItem::recalc ( )

inlinevirtual

Reimplemented by KoVariable to recalculate the value.

It exists at the KoTextCustomItem level so that KoTextParag::setCustomItem can call it to set the initial value. This should call always resize().

Reimplemented in KoDateVariable, KoTimeVariable, KoCustomVariable, KoFieldVariable, and KoPageVariable.

Definition at line 122 of file KoTextCustomItem.h.

◆ resize() [1/2]

virtual void KoTextCustomItem::resize ( )

inlinevirtual

Reimplement this to calculate the item width It is important to start with "if ( m_deleted ) return;".

Reimplemented in KoVariable, KoDateVariable, and KoTimeVariable.

Definition at line 116 of file KoTextCustomItem.h.

◆ resize() [2/2]

virtual void KoTextCustomItem::resize ( int nwidth )

inlinevirtual

Definition at line 58 of file KoTextCustomItem.h.

◆ richText()

virtual TQString KoTextCustomItem::richText ( ) const

inlinevirtual

Definition at line 66 of file KoTextCustomItem.h.

◆ save()

virtual void KoTextCustomItem::save ( TQDomElement & formatElem )

pure virtual

Save to XML.

Implemented in KoVariable.

◆ saveOasis()

virtual void KoTextCustomItem::saveOasis	(	KoXmlWriter &	writer,
		KoSavingContext &	context
	)		const

pure virtual

Save to Oasis XML.

Implemented in KoVariable, KoDateVariable, KoTimeVariable, KoCustomVariable, KoFieldVariable, and KoPageVariable.

◆ setDeleted()

virtual void KoTextCustomItem::setDeleted ( bool b )

inlinevirtual

When the user deletes a custom item, it isn't destroyed but moved into the undo/redo history - setDeleted( true ) and it can be then copied back from there into the real world - setDeleted( false ).

Definition at line 95 of file KoTextCustomItem.h.

◆ setFormat()

virtual void KoTextCustomItem::setFormat ( KoTextFormat * )

inlinevirtual

Definition at line 48 of file KoTextCustomItem.h.

◆ setParagraph()

void KoTextCustomItem::setParagraph ( KoTextParag * p )

inline

Definition at line 80 of file KoTextCustomItem.h.

◆ textDocument()

KoTextDocument * KoTextCustomItem::textDocument ( ) const

inline

The text document in which this customitem is.

Definition at line 90 of file KoTextCustomItem.h.

◆ typeId()

virtual int KoTextCustomItem::typeId ( ) const

pure virtual

Return type of custom item.

See DTD for VARIABLE.id docu.

Implemented in KoVariable.

◆ up()

bool KoTextCustomItem::up	(	KoTextCursor *	,
		KoTextDocument *&	doc,
		KoTextParag *&	parag,
		int &	idx,
		int &	ox,
		int &	oy
	)

virtual

Definition at line 53 of file KoTextCustomItem.cpp.

◆ widthHint()

virtual int KoTextCustomItem::widthHint ( ) const

inlinevirtual

Definition at line 63 of file KoTextCustomItem.h.

◆ x()

int KoTextCustomItem::x ( ) const

inline

Definition at line 44 of file KoTextCustomItem.h.

◆ y()

int KoTextCustomItem::y ( ) const

inline

Definition at line 45 of file KoTextCustomItem.h.

Member Data Documentation

◆ height

int KoTextCustomItem::height

Definition at line 69 of file KoTextCustomItem.h.

◆ m_deleted

bool KoTextCustomItem::m_deleted

protected

Definition at line 138 of file KoTextCustomItem.h.

◆ parent

KoTextDocument* KoTextCustomItem::parent

Definition at line 85 of file KoTextCustomItem.h.

◆ width

int KoTextCustomItem::width

Definition at line 68 of file KoTextCustomItem.h.

◆ xpos

int KoTextCustomItem::xpos

protected

Definition at line 141 of file KoTextCustomItem.h.

◆ ypos

int KoTextCustomItem::ypos

protected

Definition at line 142 of file KoTextCustomItem.h.

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

lib

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Placement

Constructor & Destructor Documentation

◆ KoTextCustomItem()

◆ ~KoTextCustomItem()

Member Function Documentation

◆ ascent()

◆ createCommand()

◆ deleteCommand()

◆ down()

◆ draw()

◆ drawCustomItem()

◆ enter()

◆ enterAt()

◆ finalize()

◆ format()

◆ geometry()

◆ index()

◆ invalidate()

◆ isDeleted()

◆ isNested()

◆ minimumWidth()

◆ move()

◆ next()

◆ ownLine()

◆ pageBreak()

◆ paragraph()

◆ placeInline()

◆ placement()

◆ prev()

◆ recalc()

◆ resize() [1/2]

◆ resize() [2/2]

◆ richText()

◆ save()

◆ saveOasis()

◆ setDeleted()

◆ setFormat()

◆ setParagraph()

◆ textDocument()

◆ typeId()

◆ up()

◆ widthHint()

◆ x()

◆ y()

Member Data Documentation

◆ height

◆ m_deleted

◆ parent

◆ width

◆ xpos

◆ ypos

lib

lib