kword

Public Member Functions | Static Public Member Functions | List of all members
KWFrameList Class Reference

#include <KWFrameList.h>

Public Member Functions

 KWFrameList (KWDocument *doc, KWFrame *theFrame)
 
TQValueList< KWFrame * > framesBelow () const
 
TQValueList< KWFrame * > framesOnTop () const
 
void updateAfterMove (int oldPageNum)
 
void update ()
 

Static Public Member Functions

static void recalcAllFrames (KWDocument *doc)
 
static void recalcFrames (KWDocument *doc, int pageFrom, int pageTo)
 
static void createFrameList (KWFrame *f, KWDocument *doc)
 
static void createFrameList (KWFrameSet *fs, KWDocument *doc, bool forceUpdate=true)
 

Detailed Description

This class calculates and caches a list of frames that are on top or below the KWFrame instance this class is created for.

Definition at line 32 of file KWFrameList.h.

Constructor & Destructor Documentation

◆ KWFrameList()

KWFrameList::KWFrameList ( KWDocument *  doc,
KWFrame *  theFrame 
)

Constructor.

Parameters
docthe document that will reference all framesets.
theFramethe frame this framestack work for.

Definition at line 29 of file KWFrameList.cpp.

Member Function Documentation

◆ createFrameList() [1/2]

void KWFrameList::createFrameList ( KWFrame *  f,
KWDocument *  doc 
)
static

Factory method to create and attach a new instance of a framelist.

Note; when an instance of a frameList already exists, calling this will do nothing.

Parameters
fthe frame to add te new framelist to.
docthe document that the frame belongs to.

Definition at line 179 of file KWFrameList.cpp.

◆ createFrameList() [2/2]

void KWFrameList::createFrameList ( KWFrameSet *  fs,
KWDocument *  doc,
bool  forceUpdate = true 
)
static

Factory method to create and attach a new instance of a framelist to each frame on the frameset.

Note; when an instance of a frameList already exists on a frame, calling this will not overwrite the one on that frame.

Parameters
fsthe frameset to add te new framelists to.
docthe document that the frame belongs to.
forceUpdatewhen true, even already existing frameList instances will be updated.
See also
update();

Definition at line 187 of file KWFrameList.cpp.

◆ framesBelow()

TQValueList< KWFrame * > KWFrameList::framesBelow ( ) const

Fetches the frames below the frame this frameList is for.

Definition at line 36 of file KWFrameList.cpp.

◆ framesOnTop()

TQValueList< KWFrame * > KWFrameList::framesOnTop ( ) const

Fetches the frames on top of the frame this frameList is for.

Definition at line 48 of file KWFrameList.cpp.

◆ recalcAllFrames()

void KWFrameList::recalcAllFrames ( KWDocument *  doc)
static

Update the z-ordering for all frames of the whole document.

Parameters
docthe document where we can find the frames to be updated

Definition at line 175 of file KWFrameList.cpp.

◆ recalcFrames()

void KWFrameList::recalcFrames ( KWDocument *  doc,
int  pageFrom,
int  pageTo 
)
static

Update the z-ordering for all frames in the page section of the whole document.

Parameters
docthe document where we can find the frames to be updated
pageFromthe first page that will be updated
pageTothe last page (including) that will be updated

Definition at line 163 of file KWFrameList.cpp.

◆ update()

void KWFrameList::update ( )

Update the z-ordering around the frame we host the framelist for.

This will make sure all frames on the same page will also be updated.

Definition at line 121 of file KWFrameList.cpp.

◆ updateAfterMove()

void KWFrameList::updateAfterMove ( int  oldPageNum)

Update the z-ordering around the frame we host the framelist for.

This is typically called after this frame has been moved. This will make sure all frames on the same page will also be updated.

Parameters
oldPageNuma frame that has moved naturally has a previous page number which also needs to be updated because this frame has gone missing.

Definition at line 113 of file KWFrameList.cpp.

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