#include <KWFrameSet.h>

Inheritance diagram for KWFrameSet:

Public Types
enum	Info { FI_BODY = 0 , FI_FIRST_HEADER = 1 , FI_EVEN_HEADER = 2 , FI_ODD_HEADER = 3 , FI_FIRST_FOOTER = 4 , FI_EVEN_FOOTER = 5 , FI_ODD_FOOTER = 6 , FI_FOOTNOTE = 7 }
enum	UpdateFramesFlags { UpdateFramesInPage = 1 , SortFrames = 2 }

Signals
void	repaintChanged (KWFrameSet *frameset)
void	sigFrameAdded (KWFrame *)
void	sigFrameRemoved (KWFrame *)
void	sigNameChanged (KWFrameSet *)

Public Member Functions
	KWFrameSet (KWDocument *doc)
virtual	~KWFrameSet ()
virtual KWordFrameSetIface *	dcopObject ()
virtual FrameSetType	type () const
virtual void	addTextFrameSets (TQPtrList< KWTextFrameSet > &, bool=false)
virtual bool	ownLine () const
Info	frameSetInfo () const
void	setFrameSetInfo (Info fi)
bool	isAHeader () const
bool	isAFooter () const
bool	isHeaderOrFooter () const
bool	isFootEndNote () const
const char *	headerFooterTag () const
virtual bool	isFootNote () const
virtual bool	isEndNote () const
bool	isMainFrameset () const
bool	isMoveable () const
virtual void	addFrame (KWFrame *_frame, bool recalc=true)
virtual void	deleteFrame (unsigned int num, bool remove=true, bool recalc=true)
void	deleteFrame (KWFrame *frm, bool remove=true, bool recalc=true)
virtual void	frameDeleted (KWFrame *, bool)
void	deleteAllFrames ()
void	deleteAllCopies ()
KWFrame *	frameAtPos (double _x, double _y) const
bool	isFrameAtPos (const KWFrame *frame, const TQPoint &nPoint, bool borderOfFrameOnly=false) const
KWFrame *	frame (unsigned int _num) const
const TQPtrList< KWFrame > &	frameIterator () const
int	frameFromPtr (KWFrame *frame)
unsigned int	frameCount () const
bool	isDeleted () const
virtual KWFrameSetEdit *	createFrameSetEdit (KWCanvas *)
virtual void	createEmptyRegion (const TQRect &crect, TQRegion &emptyRegion, KWViewMode *viewMode)
virtual void	drawContents (TQPainter painter, const TQRect &crect, const TQColorGroup &cg, bool onlyChanged, bool resetChanged, KWFrameSetEdit edit, KWViewMode viewMode, KWFrameViewManager frameViewManager)
void	drawFrameAndBorders (KWFrame frame, TQPainter painter, const TQRect &crect, const TQColorGroup &cg, bool, bool, KWFrameSetEdit edit, KWViewMode viewMode, KWFrame *settingsFrame, bool drawUnderlyingFrames)
void	drawFrameBorder (TQPainter painter, KWFrame frame, KWFrame settingsFrame, const TQRect &crect, KWViewMode viewMode)
virtual void	drawFrame (KWFrame frame, TQPainter painter, const TQRect &fcrect, const TQRect &crect, const TQPoint &translationOffset, KWFrame settingsFrame, const TQColorGroup &cg, bool onlyChanged, bool resetChanged, KWFrameSetEdit edit, KWViewMode *viewMode, bool drawUnderlyingFrames)
virtual void	drawFrameContents (KWFrame frame, TQPainter painter, const TQRect &fcrect, const TQColorGroup &cg, bool onlyChanged, bool resetChanged, KWFrameSetEdit edit, KWViewMode viewMode)
virtual void	drawPadding (KWFrame frame, TQPainter p, const TQRect &fcrect, const TQColorGroup &cg, KWViewMode *viewMode)
virtual void	updateFrames (int flags=0xff)
const TQPtrList< KWFrame > &	framesInPage (int pageNum) const
bool	hasFramesInPageArray () const
virtual void	layout ()
virtual void	invalidate ()
virtual TQDomElement	save (TQDomElement &parentElem, bool saveFrames=true)=0
virtual TQDomElement	toXML (TQDomElement &parentElem, bool saveFrames=true)
virtual void	saveOasis (KoXmlWriter &writer, KoSavingContext &context, bool saveFrames) const =0
virtual bool	canBeSavedAsInlineCharacter () const
virtual void	load (TQDomElement &framesetElem, bool loadFrames=true)
KWFrame *	loadOasisFrame (const TQDomElement &tag, KoOasisContext &context)
virtual void	fromXML (TQDomElement &framesetElem, bool loadFrames=true, bool=true)
virtual TQString	toPlainText () const
virtual void	finalize ()
virtual int	paragraphs ()
virtual int	paragraphsSelected ()
virtual bool	statistics (TQProgressDialog *, ulong &, ulong &, ulong &, ulong &, ulong &, ulong &, bool)
KWDocument *	kWordDocument () const
virtual bool	canRemovePage (int num)
void	setFloating ()
void	setAnchored (KWTextFrameSet textfs, KoTextParag parag, int index, bool placeHolderExists=false, bool repaint=true)
void	setAnchored (KWTextFrameSet *textfs, int paragId, int index, bool placeHolderExists=false, bool repaint=true)
void	setAnchored (KWTextFrameSet *textfs)
void	setFixed ()
bool	isFloating () const
KWTextFrameSet *	anchorFrameset () const
void	setAnchorFrameset (KWTextFrameSet *textfs)
KWAnchor *	findAnchor (int frameNum)
virtual void	setAnchorFormat (KoTextFormat *, int)
virtual KWAnchor *	createAnchor (KoTextDocument *txt, int frameNum)
virtual void	moveFloatingFrame (int frameNum, const KoPoint &position)
virtual KoSize	floatingFrameSize (int frameNum=0)
KoRect	floatingFrameRect (int frameNum=0)
virtual int	floatingFrameBaseline (int)
virtual KCommand *	anchoredObjectCreateCommand (int frameNum)
virtual KCommand *	anchoredObjectDeleteCommand (int frameNum)
void	setGroupManager (KWTableFrameSet *gm)
KWTableFrameSet *	groupmanager () const
bool	isProtectSize () const
void	setProtectSize (bool _b)
bool	isVisible (KWViewMode *viewMode=0L) const
virtual void	setVisible (bool v)
TQString	name () const
void	setName (const TQString &name)
void	setFrameBehavior (KWFrame::FrameBehavior fb)
void	setNewFrameBehavior (KWFrame::NewFrameBehavior nfb)
virtual void	printDebug ()
virtual void	printDebug (KWFrame *)
virtual KWTextFrameSet *	nextTextObject (KWFrameSet *)
bool	isPaintedBy (KWFrameSet *fs) const
virtual void	setZOrder ()
virtual void	setProtectContent (bool protect)=0
virtual bool	protectContent () const =0
void	setPageManager (KWPageManager *pm)
KWPageManager *	pageManager () const

Static Public Member Functions
static KWFrame *	settingsFrame (const KWFrame *frame)

Protected Member Functions
void	saveCommon (TQDomElement &parentElem, bool saveFrames)
TQRegion	frameClipRegion (TQPainter painter, KWFrame frame, const TQRect &crect, KWViewMode *viewMode)
void	deleteAnchor (KWAnchor *anchor)
virtual void	deleteAnchors ()
virtual void	createAnchors (KoTextParag *parag, int index, bool placeHolderExists=false, bool repaint=true)

Protected Attributes
KWDocument *	m_doc
TQPtrList< KWFrame >	m_frames
TQPtrVector< TQPtrList< KWFrame > >	m_framesInPage
int	m_firstPage
TQPtrList< KWFrame >	m_emptyList
Info	m_info
KWTableFrameSet *	m_groupmanager
bool	m_visible
bool	m_protectSize
TQString	m_name
KWTextFrameSet *	m_anchorTextFs
KWordFrameSetIface *	m_dcop
KWPageManager *	m_pageManager

Detailed Description

Class: KWFrameSet Base type, a frameset holds content as well as frames to show that content.

The different types of content are implemented in the different types of frameSet implementations (see below)

See also: KWTextFrameSet, KWPartFrameSet, KWPictureFrameSet, KWFormulaFrameSet, KWTableFrameSet

Definition at line 61 of file KWFrameSet.h.

Member Enumeration Documentation

◆ Info

enum KWFrameSet::Info

The different types of textFramesets (that TEXT is important here!) FI_BODY = normal text frames.

FI_FIRST_HEADER = Header on page 1
FI_EVEN_HEADER = header on any even page
FI_ODD_HEADER = header on any odd page (can be including page 1)
FI_FIRST_FOOTER = footer on page 1
FI_EVEN_FOOTER = footer on any even page
FI_ODD_FOOTER = footer on any odd page (can be including page 1)
FI_FOOTNOTE = a footnote frame.

Definition at line 91 of file KWFrameSet.h.

◆ UpdateFramesFlags

enum KWFrameSet::UpdateFramesFlags

Enumerator
SortFrames	kwtextframeset only

Definition at line 295 of file KWFrameSet.h.

Constructor & Destructor Documentation

◆ KWFrameSet()

KWFrameSet::KWFrameSet ( KWDocument * doc )

constructor

Definition at line 45 of file KWFrameSet.cpp.

◆ ~KWFrameSet()

KWFrameSet::~KWFrameSet ( )

virtual

destructor

Definition at line 72 of file KWFrameSet.cpp.

Member Function Documentation

◆ addFrame()

void KWFrameSet::addFrame	(	KWFrame *	_frame,
		bool	recalc = true )

virtual

Definition at line 77 of file KWFrameSet.cpp.

◆ addTextFrameSets()

virtual void KWFrameSet::addTextFrameSets	(	TQPtrList< KWTextFrameSet > &	,
		bool	= false )

inlinevirtual

Definition at line 78 of file KWFrameSet.h.

◆ anchoredObjectCreateCommand()

KCommand * KWFrameSet::anchoredObjectCreateCommand ( int frameNum )

virtual

Store command for creating an anchored object.

Reimplemented in KWTableFrameSet.

Definition at line 489 of file KWFrameSet.cpp.

◆ anchoredObjectDeleteCommand()

KCommand * KWFrameSet::anchoredObjectDeleteCommand ( int frameNum )

virtual

Store command for deleting an anchored object.

Reimplemented in KWTableFrameSet.

Definition at line 496 of file KWFrameSet.cpp.

◆ anchorFrameset()

KWTextFrameSet * KWFrameSet::anchorFrameset ( ) const

inline

Return the frameset in which our anchor is - assuming isFloating().

Definition at line 374 of file KWFrameSet.h.

◆ canBeSavedAsInlineCharacter()

virtual bool KWFrameSet::canBeSavedAsInlineCharacter ( ) const

inlinevirtual

If the frameset is inline, is it ok to save it inside an oasis <text:p>?

If not, KWAnchor will create a textbox around it.

Reimplemented in KWTableFrameSet.

Definition at line 326 of file KWFrameSet.h.

◆ canRemovePage()

bool KWFrameSet::canRemovePage ( int num )

virtual

Return true if page num can be removed, as far as this frameset is concerned.

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 1129 of file KWFrameSet.cpp.

◆ createAnchor()

KWAnchor * KWFrameSet::createAnchor	(	KoTextDocument *	txt,
		int	frameNum )

virtual

Create an anchor for the floating frame identified by frameNum.

Reimplemented in KWTableFrameSet.

Definition at line 377 of file KWFrameSet.cpp.

◆ createAnchors()

void KWFrameSet::createAnchors	(	KoTextParag *	parag,
		int	index,
		bool	placeHolderExists = false,
		bool	repaint = true )

protectedvirtual

Definition at line 383 of file KWFrameSet.cpp.

◆ createEmptyRegion()

void KWFrameSet::createEmptyRegion	(	const TQRect &	crect,
		TQRegion &	emptyRegion,
		KWViewMode *	viewMode )

virtual

Let the caller know which parts of emptyRegion we do not claim, and thus the caller is free to paint on without interfering with later paints from us.

For painting all frames of all framesets the painter needs to find out what area we will fill with a background color and possibly paint over. What this method does is fill an TQRegion with all the areas we are going to fill, which typically means we will paint the background of a frame there.

Parameters

emptyRegion	The region is modified to subtract the areas painted, thus allowing the caller to determine which areas remain to be painted. Framesets that can be transparent should reimplement this and make it a no-op, so that the background is painted below the transparent frame.
crect	the cliprect; only parts inside this rect are of interrest to us
viewMode	For coordinate conversion, always set.

Reimplemented in KWPartFrameSet, and KWTableFrameSet.

Definition at line 160 of file KWFrameSet.cpp.

◆ createFrameSetEdit()

virtual KWFrameSetEdit * KWFrameSet::createFrameSetEdit ( KWCanvas * )

inlinevirtual

Create a framesetedit object to edit this frameset in canvas.

Reimplemented in KWPartFrameSet, KWTableFrameSet, and KWTextFrameSet.

Definition at line 169 of file KWFrameSet.h.

◆ dcopObject()

KWordFrameSetIface * KWFrameSet::dcopObject ( )

virtual

Definition at line 63 of file KWFrameSet.cpp.

◆ deleteAllCopies()

void KWFrameSet::deleteAllCopies ( )

Definition at line 149 of file KWFrameSet.cpp.

◆ deleteAllFrames()

void KWFrameSet::deleteAllFrames ( )

Definition at line 138 of file KWFrameSet.cpp.

◆ deleteAnchor()

void KWFrameSet::deleteAnchor ( KWAnchor * anchor )

protected

Definition at line 405 of file KWFrameSet.cpp.

◆ deleteAnchors()

void KWFrameSet::deleteAnchors ( )

protectedvirtual

Definition at line 420 of file KWFrameSet.cpp.

◆ deleteFrame() [1/2]

void KWFrameSet::deleteFrame	(	KWFrame *	frm,
		bool	remove = true,
		bool	recalc = true )

Delete a frame from the set of frames this frameSet has.

Parameters

frm	The frame that should be deleted
remove	passing true means that there can not be an undo of the action.
recalc	do an updateFrames()

Definition at line 127 of file KWFrameSet.cpp.

◆ deleteFrame() [2/2]

void KWFrameSet::deleteFrame	(	unsigned int	num,
		bool	remove = true,
		bool	recalc = true )

virtual

Delete a frame from the set of frames this frameSet has.

Parameters

num	The frameNumber to be removed.
remove	passing true means that there can not be an undo of the action.
recalc	do an updateFrames()

Reimplemented in KWPartFrameSet, and KWTextFrameSet.

Definition at line 93 of file KWFrameSet.cpp.

◆ drawContents()

void KWFrameSet::drawContents	(	TQPainter *	painter,
		const TQRect &	crect,
		const TQColorGroup &	cg,
		bool	onlyChanged,
		bool	resetChanged,
		KWFrameSetEdit *	edit,
		KWViewMode *	viewMode,
		KWFrameViewManager *	frameViewManager )

virtual

Paint this frameset.

Parameters

painter	The painter in which to draw the contents of the frameset
crect	The rectangle (in scrollview "contents coordinates", i.e. "view coords") to be painted
cg	The colorgroup from which to get the colors
onlyChanged	If true, only redraw what has changed (see KWCanvas::repaintChanged)
resetChanged	If true, set the changed flag to false after drawing.
edit	If set, this frameset is being edited, so a cursor is needed.
viewMode	For coordinate conversion, always set.
frameViewManager	the frameViewManager;

The way this "onlyChanged/resetChanged" works is: when something changes, all views are asked to redraw themselves with onlyChanged=true. But all views except the last one shouldn't reset the changed flag to false, otherwise the other views wouldn't repaint anything. So resetChanged is called with "false" for all views except the last one, and with "true" for the last one, so that it resets the flag.

Framesets shouldn't reimplement this one in theory [but KWTableFrameSet has to].

Reimplemented in KWTableFrameSet::Cell, KWTableFrameSet, and KWTextFrameSet.

Definition at line 632 of file KWFrameSet.cpp.

◆ drawFrame()

void KWFrameSet::drawFrame	(	KWFrame *	frame,
		TQPainter *	painter,
		const TQRect &	fcrect,
		const TQRect &	crect,
		const TQPoint &	translationOffset,
		KWFrame *	settingsFrame,
		const TQColorGroup &	cg,
		bool	onlyChanged,
		bool	resetChanged,
		KWFrameSetEdit *	edit,
		KWViewMode *	viewMode,
		bool	drawUnderlyingFrames )

virtual

Draw a particular frame of this frameset.

This is called by drawContents and is what framesets must reimplement.

Parameters

fcrect	rectangle to be repainted, in the frame's coordinate system, in pixels. Doesn't include padding.
crect	rectangle to be repainted, in view coordinates. Includes padding. Default implementation does double-buffering and calls drawFrameContents.
frame	the frame to draw
painter	the painter to draw to
settingsFrame	The frame from which we take the settings (usually `frame`, but not with Copy behaviour)
cg	The colorgroup from which to get the colors
onlyChanged	If true, only redraw what has changed (see KWCanvas::repaintChanged)
resetChanged	If true, set the changed flag to false after drawing.
edit	If set, this frameset is being edited, so a cursor is needed.
viewMode	For coordinate conversion, always set.
drawUnderlyingFrames	if the frame implements it, then it should draw underlying frames.
translationOffset	offset this method will translate the paiter before doing its work.

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 757 of file KWFrameSet.cpp.

◆ drawFrameAndBorders()

void KWFrameSet::drawFrameAndBorders	(	KWFrame *	frame,
		TQPainter *	painter,
		const TQRect &	crect,
		const TQColorGroup &	cg,
		bool	onlyChanged,
		bool	resetChanged,
		KWFrameSetEdit *	edit,
		KWViewMode *	viewMode,
		KWFrame *	settingsFrame,
		bool	drawUnderlyingFrames )

This one is called by drawContents for each frame.

It sets up clip rect and painter translation, and calls drawFrame, drawFrameBorder and drawMargins

Parameters

drawUnderlyingFrames	if the frame implements it, then it should draw underlying frames. This is set to false by the default drawFrame implementation, so that the frames under a transparent frame are simply drawn, without transparency handling (nor their own double-buffering).
frame	the frame to draw
painter	the painter to draw to
settingsFrame	The frame from which we take the settings (usually `frame`, but not with Copy behaviour)
cg	The colorgroup from which to get the colors
edit	If set, this frameset is being edited, so a cursor is needed.
viewMode	For coordinate conversion, always set.
crect	rectangle to be repainted, in view coordinates. Includes padding.

Definition at line 682 of file KWFrameSet.cpp.

◆ drawFrameBorder()

void KWFrameSet::drawFrameBorder	(	TQPainter *	painter,
		KWFrame *	frame,
		KWFrame *	settingsFrame,
		const TQRect &	crect,
		KWViewMode *	viewMode )

Paint the borders for one frame of this frameset.

Parameters

painter	The painter in which to draw the contents of the frameset
frame	The frame to be drawn
settingsFrame	The frame from which we take the settings (usually `frame`, but not with Copy behaviour)
crect	The rectangle (in "contents coordinates") to be painted
viewMode	For coordinate conversion, always set.

Definition at line 237 of file KWFrameSet.cpp.

◆ drawFrameContents()

void KWFrameSet::drawFrameContents	(	KWFrame *	frame,
		TQPainter *	painter,
		const TQRect &	fcrect,
		const TQColorGroup &	cg,
		bool	onlyChanged,
		bool	resetChanged,
		KWFrameSetEdit *	edit,
		KWViewMode *	viewMode )

virtual

Implement this one instead of drawFrame to benefit from double-buffering AND transparency handling (painting frames below this one) automatically.

You MUST reimplement one or the other, or you'll get infinite recursion ;)

In this method, the painter has been translated to the frame's coordinate system

Parameters

fcrect	rectangle to be repainted, in the frame's coordinate system, in pixels. Doesn't include padding.
frame	the frame to draw
painter	the painter to draw to
cg	The colorgroup from which to get the colors
onlyChanged	If true, only redraw what has changed (see KWCanvas::repaintChanged)
resetChanged	If true, set the changed flag to false after drawing.
edit	If set, this frameset is being edited, so a cursor is needed.
viewMode	For coordinate conversion, always set.

Reimplemented in KWPartFrameSet, and KWTextFrameSet.

Definition at line 862 of file KWFrameSet.cpp.

◆ drawPadding()

void KWFrameSet::drawPadding	(	KWFrame *	frame,
		TQPainter *	p,
		const TQRect &	fcrect,
		const TQColorGroup &	cg,
		KWViewMode *	viewMode )

virtual

Draw the padding area inside of a specific frame of this frameSet.

Definition at line 187 of file KWFrameSet.cpp.

◆ finalize()

void KWFrameSet::finalize ( )

virtual

Called once the frameset has been completely loaded or constructed.

The default implementation calls updateFrames() and zoom(). Call the parent :)

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 1074 of file KWFrameSet.cpp.

◆ findAnchor()

KWAnchor * KWFrameSet::findAnchor ( int frameNum )

Return the anchor object for this frame number.

Definition at line 343 of file KWFrameSet.cpp.

◆ floatingFrameBaseline()

virtual int KWFrameSet::floatingFrameBaseline ( int )

inlinevirtual

Get the 'baseline' to use for the "floating frame" identified by frameNum.

-1 means same as the height (usual case)

Definition at line 397 of file KWFrameSet.h.

◆ floatingFrameRect()

KoRect KWFrameSet::floatingFrameRect ( int frameNum = 0 )

Get the rect of the "floating frame" identified by frameNum, in coordinates RELATIVE TO THE PARENT FRAMESET.

This is especially important for multi-parent inline frames.

Definition at line 466 of file KWFrameSet.cpp.

◆ floatingFrameSize()

KoSize KWFrameSet::floatingFrameSize ( int frameNum = 0 )

virtual

Get the size of the "floating frame" identified by frameNum.

By default a real frame but not for tables.

Reimplemented in KWTableFrameSet.

Definition at line 482 of file KWFrameSet.cpp.

◆ frame()

KWFrame * KWFrameSet::frame ( unsigned int _num ) const

get a frame by number

Definition at line 513 of file KWFrameSet.cpp.

◆ frameAtPos()

KWFrame * KWFrameSet::frameAtPos	(	double	_x,
		double	_y ) const

retrieve frame from x and y coords (unzoomed coords)

Note: for headers/footers only

Definition at line 503 of file KWFrameSet.cpp.

◆ frameClipRegion()

TQRegion KWFrameSet::frameClipRegion	(	TQPainter *	painter,
		KWFrame *	frame,
		const TQRect &	crect,
		KWViewMode *	viewMode )

protected

Determine the clipping rectangle for drawing the contents of frame with painter in the rectangle delimited by crect.

This determines where to clip the painter to draw the contents of a given frame

if ( onlyChanged )

Definition at line 1080 of file KWFrameSet.cpp.

◆ frameCount()

unsigned int KWFrameSet::frameCount ( ) const

inline

Get number of child frames.

Definition at line 163 of file KWFrameSet.h.

◆ frameDeleted()

virtual void KWFrameSet::frameDeleted	(	KWFrame *	,
		bool	)

inlinevirtual

Called by deleteFrame when it really deletes a frame (remove=true), to remove it from the table too.

Reimplemented in KWTableFrameSet::Cell.

Definition at line 129 of file KWFrameSet.h.

◆ frameFromPtr()

int KWFrameSet::frameFromPtr ( KWFrame * frame )

Get frame number.

Definition at line 519 of file KWFrameSet.cpp.

◆ frameIterator()

const TQPtrList< KWFrame > & KWFrameSet::frameIterator ( ) const

inline

Iterator over the child frames.

Definition at line 159 of file KWFrameSet.h.

◆ frameSetInfo()

Info KWFrameSet::frameSetInfo ( ) const

inline

Returns the type of TextFrameSet this is.

Definition at line 95 of file KWFrameSet.h.

◆ framesInPage()

const TQPtrList< KWFrame > & KWFrameSet::framesInPage ( int pageNum ) const

Return list of frames in page pageNum.

This is fast since it uses the m_framesInPage array.

Definition at line 618 of file KWFrameSet.cpp.

◆ fromXML()

virtual void KWFrameSet::fromXML	(	TQDomElement &	framesetElem,
		bool	loadFrames = true,
		bool	= true )

inlinevirtual

load from XML - when pasting from clipboard

Reimplemented in KWTableFrameSet.

Definition at line 332 of file KWFrameSet.h.

◆ groupmanager()

KWTableFrameSet * KWFrameSet::groupmanager ( ) const

inline

returns the groupManager this frameset belongs to.

A Groupmanager is better known as a table

Definition at line 408 of file KWFrameSet.h.

◆ hasFramesInPageArray()

bool KWFrameSet::hasFramesInPageArray ( ) const

inline

Allows to detect that updateFrames() hasn't been called yet (e.g.

on loading)

Definition at line 311 of file KWFrameSet.h.

◆ headerFooterTag()

const char * KWFrameSet::headerFooterTag ( ) const

Definition at line 1054 of file KWFrameSet.cpp.

◆ invalidate()

virtual void KWFrameSet::invalidate ( )

inlinevirtual

Reimplemented in KWTextFrameSet.

Definition at line 315 of file KWFrameSet.h.

◆ isAFooter()

bool KWFrameSet::isAFooter ( ) const

Definition at line 1031 of file KWFrameSet.cpp.

◆ isAHeader()

bool KWFrameSet::isAHeader ( ) const

Definition at line 1026 of file KWFrameSet.cpp.

◆ isDeleted()

bool KWFrameSet::isDeleted ( ) const

inline

True if the frameset was deleted (but not destroyed, since it's in the undo/redo).

Definition at line 166 of file KWFrameSet.h.

◆ isEndNote()

virtual bool KWFrameSet::isEndNote ( ) const

inlinevirtual

Definition at line 106 of file KWFrameSet.h.

◆ isFloating()

bool KWFrameSet::isFloating ( ) const

inline

Return true if this frameset is floating (inline), false if it's fixed.

Definition at line 372 of file KWFrameSet.h.

◆ isFootEndNote()

bool KWFrameSet::isFootEndNote ( ) const

Definition at line 1036 of file KWFrameSet.cpp.

◆ isFootNote()

virtual bool KWFrameSet::isFootNote ( ) const

inlinevirtual

Definition at line 105 of file KWFrameSet.h.

◆ isFrameAtPos()

bool KWFrameSet::isFrameAtPos	(	const KWFrame *	frame,
		const TQPoint &	nPoint,
		bool	borderOfFrameOnly = false ) const

Return if the point is on the frame.

Parameters

nPoint	the point in normal coordinates.
borderOfFrameOnly	when true an additional check is done if the point is on the border.
frame	the frame to check inside of

Definition at line 1159 of file KWFrameSet.cpp.

◆ isHeaderOrFooter()

bool KWFrameSet::isHeaderOrFooter ( ) const

inline

Definition at line 101 of file KWFrameSet.h.

◆ isMainFrameset()

bool KWFrameSet::isMainFrameset ( ) const

Definition at line 1041 of file KWFrameSet.cpp.

◆ isMoveable()

bool KWFrameSet::isMoveable ( ) const

Definition at line 1047 of file KWFrameSet.cpp.

◆ isPaintedBy()

bool KWFrameSet::isPaintedBy ( KWFrameSet * fs ) const

Definition at line 600 of file KWFrameSet.cpp.

◆ isProtectSize()

bool KWFrameSet::isProtectSize ( ) const

inline

Definition at line 410 of file KWFrameSet.h.

◆ isVisible()

bool KWFrameSet::isVisible ( KWViewMode * viewMode = 0L ) const

Returns true if the frameset is visible.

A frameset is visible if setVisible(false) wasn't called, but also, for a header frameset, if m_doc->isHeaderVisible is true, etc. For an "even pages header" frameset, the corresponding headerType setting must be selected (i.e. different headers for even and odd pages).

Parameters

viewMode pass the current viewmode when using this method for any visual stuff (drawing, handling input etc.). Frameset visibility depends on the viewmode.

Definition at line 992 of file KWFrameSet.cpp.

◆ kWordDocument()

KWDocument * KWFrameSet::kWordDocument ( ) const

inline

Definition at line 348 of file KWFrameSet.h.

◆ layout()

virtual void KWFrameSet::layout ( )

inlinevirtual

relayout text in frames, so that it flows correctly around other frames

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 314 of file KWFrameSet.h.

◆ load()

void KWFrameSet::load	(	TQDomElement &	framesetElem,
		bool	loadFrames = true )

virtual

load from XML - when loading

Reimplemented in KWPartFrameSet, and KWTextFrameSet.

Definition at line 909 of file KWFrameSet.cpp.

◆ loadOasisFrame()

KWFrame * KWFrameSet::loadOasisFrame	(	const TQDomElement &	tag,
		KoOasisContext &	context )

Definition at line 936 of file KWFrameSet.cpp.

◆ moveFloatingFrame()

void KWFrameSet::moveFloatingFrame	(	int	frameNum,
		const KoPoint &	position )

virtual

Move the frame frameNum to the given position - this is called when the frame is anchored and the anchor moves (see KWAnchor).

Reimplemented in KWPartFrameSet, and KWTableFrameSet.

Definition at line 443 of file KWFrameSet.cpp.

◆ name()

TQString KWFrameSet::name ( ) const

inline

get/set frameset name. For tables in particular, this must be unique

Definition at line 428 of file KWFrameSet.h.

◆ nextTextObject()

virtual KWTextFrameSet * KWFrameSet::nextTextObject ( KWFrameSet * )

inlinevirtual

Reimplemented in KWTextFrameSet.

Definition at line 442 of file KWFrameSet.h.

◆ ownLine()

virtual bool KWFrameSet::ownLine ( ) const

inlinevirtual

Definition at line 79 of file KWFrameSet.h.

◆ pageManager()

KWPageManager * KWFrameSet::pageManager ( ) const

inline

Definition at line 453 of file KWFrameSet.h.

◆ paragraphs()

virtual int KWFrameSet::paragraphs ( )

inlinevirtual

Reimplemented in KWTableFrameSet.

Definition at line 343 of file KWFrameSet.h.

◆ paragraphsSelected()

virtual int KWFrameSet::paragraphsSelected ( )

inlinevirtual

Definition at line 344 of file KWFrameSet.h.

◆ printDebug() [1/2]

void KWFrameSet::printDebug ( )

virtual

Definition at line 1198 of file KWFrameSet.cpp.

◆ printDebug() [2/2]

void KWFrameSet::printDebug ( KWFrame * )

virtual

Definition at line 1271 of file KWFrameSet.cpp.

◆ repaintChanged

void KWFrameSet::repaintChanged ( KWFrameSet * frameset )

signal

Emitted when something has changed in this frameset, so that all views repaint it.

KWDocument connects to it, and KWCanvas connects to KWDocument.

◆ save()

virtual TQDomElement KWFrameSet::save	(	TQDomElement &	parentElem,
		bool	saveFrames = true )

pure virtual

save to XML - when saving

Implemented in KWPartFrameSet, KWTableFrameSet, and KWTextFrameSet.

◆ saveCommon()

void KWFrameSet::saveCommon	(	TQDomElement &	parentElem,
		bool	saveFrames )

protected

save the common attributes for the frameset

Definition at line 868 of file KWFrameSet.cpp.

◆ saveOasis()

virtual void KWFrameSet::saveOasis	(	KoXmlWriter &	writer,
		KoSavingContext &	context,
		bool	saveFrames ) const

pure virtual

Save to OASIS format.

Implemented in KWPartFrameSet, KWTableFrameSet, and KWTextFrameSet.

◆ setAnchored() [1/3]

void KWFrameSet::setAnchored ( KWTextFrameSet * textfs )

Note that this frameset has been made floating already, and store anchor position.

Definition at line 333 of file KWFrameSet.cpp.

◆ setAnchored() [2/3]

void KWFrameSet::setAnchored	(	KWTextFrameSet *	textfs,
		int	paragId,
		int	index,
		bool	placeHolderExists = false,
		bool	repaint = true )

Make this frameset floating, with the anchor at paragId,index in the text frameset textfs.

Deprecated

Definition at line 306 of file KWFrameSet.cpp.

◆ setAnchored() [3/3]

void KWFrameSet::setAnchored	(	KWTextFrameSet *	textfs,
		KoTextParag *	parag,
		int	index,
		bool	placeHolderExists = false,
		bool	repaint = true )

Make this frameset anchored, with the anchor at paragId,index in the text frameset textfs.

Also used during OASIS loading (placeHolderExists=true)

Definition at line 314 of file KWFrameSet.cpp.

◆ setAnchorFormat()

virtual void KWFrameSet::setAnchorFormat	(	KoTextFormat *	,
		int	)

inlinevirtual

Tell this frame the format of it's anchor.

Definition at line 380 of file KWFrameSet.h.

◆ setAnchorFrameset()

void KWFrameSet::setAnchorFrameset ( KWTextFrameSet * textfs )

inline

Sets the frameset in which we are about to become inline. Used for OASIS loading.

Definition at line 376 of file KWFrameSet.h.

◆ setFixed()

void KWFrameSet::setFixed ( )

Make this frameset fixed, i.e. not anchored.

Definition at line 361 of file KWFrameSet.cpp.

◆ setFloating()

void KWFrameSet::setFloating ( )

Make this frameset floating (anchored), as close to its current position as possible.

Definition at line 278 of file KWFrameSet.cpp.

◆ setFrameBehavior()

void KWFrameSet::setFrameBehavior ( KWFrame::FrameBehavior fb )

set frameBehavior on all frames, see KWFrame for specifics

Definition at line 1148 of file KWFrameSet.cpp.

◆ setFrameSetInfo()

void KWFrameSet::setFrameSetInfo ( Info fi )

inline

Set the type of TextFrameSet this is.

Definition at line 97 of file KWFrameSet.h.

◆ setGroupManager()

void KWFrameSet::setGroupManager ( KWTableFrameSet * gm )

inline

make this frameset part of a groupmanager

See also: KWTableFrameSet

Definition at line 406 of file KWFrameSet.h.

◆ setName()

void KWFrameSet::setName ( const TQString & name )

Definition at line 1189 of file KWFrameSet.cpp.

◆ setNewFrameBehavior()

void KWFrameSet::setNewFrameBehavior ( KWFrame::NewFrameBehavior nfb )

set newFrameBehavior on all frames, see KWFrame for specifics

Definition at line 1153 of file KWFrameSet.cpp.

◆ setPageManager()

void KWFrameSet::setPageManager ( KWPageManager * pm )

inline

Definition at line 452 of file KWFrameSet.h.

◆ setProtectSize()

void KWFrameSet::setProtectSize ( bool _b )

Definition at line 301 of file KWFrameSet.cpp.

◆ settingsFrame()

KWFrame * KWFrameSet::settingsFrame ( const KWFrame * frame )

static

Returns the original frame that the param frame is a copy off, or the frame itself.

For changing a frame that is a copy of another (as found in KWFrame::isCopy()) you need a so called settings frame, or original frame. This method can savely be called on any frame to make sure you are dealing with the original frame.

Parameters

frame the frame to find the settings frame for.

Returns: the frame itself if its not a copy, or the original frame if it is one.

Definition at line 524 of file KWFrameSet.cpp.

◆ setVisible()

void KWFrameSet::setVisible ( bool v )

virtual

set the visibility of the frameset.

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 984 of file KWFrameSet.cpp.

◆ setZOrder()

void KWFrameSet::setZOrder ( )

virtual

set z-order for all frames

Reimplemented in KWTableFrameSet::Cell, and KWTableFrameSet.

Definition at line 1181 of file KWFrameSet.cpp.

◆ statistics()

virtual bool KWFrameSet::statistics	(	TQProgressDialog *	,
		ulong &	,
		ulong &	,
		ulong &	,
		ulong &	,
		ulong &	,
		ulong &	,
		bool	)

inlinevirtual

Reimplemented in KWTextFrameSet.

Definition at line 345 of file KWFrameSet.h.

◆ toPlainText()

virtual TQString KWFrameSet::toPlainText ( ) const

inlinevirtual

Definition at line 335 of file KWFrameSet.h.

◆ toXML()

virtual TQDomElement KWFrameSet::toXML	(	TQDomElement &	parentElem,
		bool	saveFrames = true )

inlinevirtual

save to XML - when copying to clipboard

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 320 of file KWFrameSet.h.

◆ type()

virtual FrameSetType KWFrameSet::type ( ) const

inlinevirtual

The type of frameset.

Use this to differentiate between different instantiations of the framesets. Each implementation will return a different frameType.

Reimplemented in KWPartFrameSet, KWTableFrameSet, and KWTextFrameSet.

Definition at line 76 of file KWFrameSet.h.

◆ updateFrames()

void KWFrameSet::updateFrames ( int flags = 0xff )

virtual

Called when our frames change, or when another frameset's frames change.

Framesets can reimplement it, but should always call the parent method.

Reimplemented in KWTableFrameSet, and KWTextFrameSet.

Definition at line 541 of file KWFrameSet.cpp.

Member Data Documentation

◆ m_anchorTextFs

KWTextFrameSet* KWFrameSet::m_anchorTextFs

protected

Definition at line 500 of file KWFrameSet.h.

◆ m_dcop

KWordFrameSetIface* KWFrameSet::m_dcop

protected

Definition at line 501 of file KWFrameSet.h.

◆ m_doc

KWDocument* KWFrameSet::m_doc

protected

Definition at line 484 of file KWFrameSet.h.

◆ m_emptyList

TQPtrList<KWFrame> KWFrameSet::m_emptyList

protected

always empty, for convenience in framesInPage

Definition at line 493 of file KWFrameSet.h.

◆ m_firstPage

int KWFrameSet::m_firstPage

protected

always equal to m_framesInPage[0].first()->pageNumber() :)

Definition at line 491 of file KWFrameSet.h.

◆ m_frames

TQPtrList<KWFrame> KWFrameSet::m_frames

protected

Definition at line 485 of file KWFrameSet.h.

◆ m_framesInPage

TQPtrVector< TQPtrList<KWFrame> > KWFrameSet::m_framesInPage

protected

This array provides a direct access to the frames on page N.

Definition at line 489 of file KWFrameSet.h.

◆ m_groupmanager

KWTableFrameSet* KWFrameSet::m_groupmanager

protected

Definition at line 496 of file KWFrameSet.h.

◆ m_info

Info KWFrameSet::m_info

protected

Definition at line 495 of file KWFrameSet.h.

◆ m_name

TQString KWFrameSet::m_name

protected

Definition at line 499 of file KWFrameSet.h.

◆ m_pageManager

KWPageManager* KWFrameSet::m_pageManager

protected

Definition at line 502 of file KWFrameSet.h.

◆ m_protectSize

bool KWFrameSet::m_protectSize

protected

Definition at line 498 of file KWFrameSet.h.

◆ m_visible

bool KWFrameSet::m_visible

protected

Definition at line 497 of file KWFrameSet.h.

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

kword

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Info

◆ UpdateFramesFlags

Constructor & Destructor Documentation

◆ KWFrameSet()

◆ ~KWFrameSet()

Member Function Documentation

◆ addFrame()

◆ addTextFrameSets()

◆ anchoredObjectCreateCommand()

◆ anchoredObjectDeleteCommand()

◆ anchorFrameset()

◆ canBeSavedAsInlineCharacter()

◆ canRemovePage()

◆ createAnchor()

◆ createAnchors()

◆ createEmptyRegion()

◆ createFrameSetEdit()

◆ dcopObject()

◆ deleteAllCopies()

◆ deleteAllFrames()

◆ deleteAnchor()

◆ deleteAnchors()

◆ deleteFrame() [1/2]

◆ deleteFrame() [2/2]

◆ drawContents()

◆ drawFrame()

◆ drawFrameAndBorders()

◆ drawFrameBorder()

◆ drawFrameContents()

◆ drawPadding()

◆ finalize()

◆ findAnchor()

◆ floatingFrameBaseline()

◆ floatingFrameRect()

◆ floatingFrameSize()

◆ frame()

◆ frameAtPos()

◆ frameClipRegion()

if ( onlyChanged )

◆ frameCount()

◆ frameDeleted()

◆ frameFromPtr()

◆ frameIterator()

◆ frameSetInfo()

◆ framesInPage()

◆ fromXML()

◆ groupmanager()

◆ hasFramesInPageArray()

◆ headerFooterTag()

◆ invalidate()

◆ isAFooter()

◆ isAHeader()

◆ isDeleted()

◆ isEndNote()

◆ isFloating()

◆ isFootEndNote()

◆ isFootNote()

◆ isFrameAtPos()

◆ isHeaderOrFooter()

◆ isMainFrameset()

◆ isMoveable()

◆ isPaintedBy()

◆ isProtectSize()

◆ isVisible()

◆ kWordDocument()

◆ layout()

◆ load()

◆ loadOasisFrame()

◆ moveFloatingFrame()

◆ name()

◆ nextTextObject()