kword/part

KWFrame Class Reference

This class represents a single frame. More...

#include <KWFrame.h>

Inheritance diagram for KWFrame:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 KWFrame (KoShape *shape, KWFrameSet *parent, int pageNumber=-1)
virtual ~KWFrame ()
void attachAnchor (KoTextAnchor *anchor)
void clearLoadingData ()
virtual void copySettings (const KWFrame *frame)
KWord::FrameBehavior frameBehavior () const
bool frameOnBothSheets () const
KWFrameSet * frameSet () const
KoTextAnchor * getAnchor ()
bool isCopy () const
int loadingPageNumber () const
KWord::NewFrameBehavior newFrameBehavior () const
KWOutlineShape * outlineShape () const
qreal runAroundDistance () const
KWord::RunAroundSide runAroundSide () const
void saveOdf (KoShapeSavingContext &context)
void setFrameBehavior (KWord::FrameBehavior fb)
void setFrameOnBothSheets (bool both)
virtual void setFrameSet (KWFrameSet *newFrameSet)
void setNewFrameBehavior (KWord::NewFrameBehavior nf)
void setOutlineShape (KWOutlineShape *outline)
void setRunAroundDistance (qreal distance)
void setRunAroundSide (KWord::RunAroundSide side)
void setTextRunAround (KWord::TextRunAround runAround)
KoShape * shape () const
KWord::TextRunAround textRunAround () const

Protected Member Functions

void setShape (KoShape *shape)

Detailed Description

This class represents a single frame.

A frame belongs to a frameset which states its contents. A frame does NOT have contents, the frameset stores that. A frame is really just a shape that is used to place the content of a frameset.

Definition at line 42 of file KWFrame.h.

Constructor & Destructor Documentation

KWFrame::KWFrame ( KoShape *  shape,
KWFrameSet *  parent,
int  pageNumber = -1 
)

Constructor.

Parameters:
shape the shape that displays the content, containing size/position
parent the parent frameset
pageNumber the page number is normally -1, only set when loading page anchored frames to the page where the frame should be positioned

Definition at line 29 of file KWFrame.cpp.

KWFrame::~KWFrame (  )  [virtual]

Definition at line 50 of file KWFrame.cpp.

Member Function Documentation

void KWFrame::attachAnchor ( KoTextAnchor *  anchor  ) 

Definition at line 117 of file KWFrame.cpp.

void KWFrame::clearLoadingData (  )  [inline]

Definition at line 169 of file KWFrame.h.

void KWFrame::copySettings ( const KWFrame *  frame  )  [virtual]

Copy all the settings from the parameter frame and apply them to this frame.

Parameters:
frame the frame to use as original

Definition at line 74 of file KWFrame.cpp.

KWord::FrameBehavior KWFrame::frameBehavior (  )  const [inline]

This property what should happen when the frame is full.

Definition at line 58 of file KWFrame.h.

bool KWFrame::frameOnBothSheets (  )  const [inline]

For frame duplication policy on new page creation.

Determines if this frame will be copied on even or odd pages only.

Definition at line 73 of file KWFrame.h.

KWFrameSet* KWFrame::frameSet (  )  const [inline]

Return the parent frameset.

Returns:
the parent frameset

Definition at line 158 of file KWFrame.h.

KoTextAnchor * KWFrame::getAnchor (  ) 

Definition at line 122 of file KWFrame.cpp.

bool KWFrame::isCopy (  )  const

States if this frame is a copy of the previous one.

If this frame is a copy, then this frame is drawn with the same content as the previous frame in this frameset.

Returns:
true if this is a copy

Definition at line 107 of file KWFrame.cpp.

int KWFrame::loadingPageNumber (  )  const [inline]

Definition at line 172 of file KWFrame.h.

KWord::NewFrameBehavior KWFrame::newFrameBehavior (  )  const [inline]

For frame duplication policy on new page creation.

Definition at line 88 of file KWFrame.h.

KWOutlineShape* KWFrame::outlineShape (  )  const [inline]

Definition at line 196 of file KWFrame.h.

qreal KWFrame::runAroundDistance (  )  const [inline]

The space between this frames edge and the text when that text runs around this frame.

Returns:
the space around this frame to keep free from text

Definition at line 135 of file KWFrame.h.

KWord::RunAroundSide KWFrame::runAroundSide (  )  const [inline]

Return the side around text from another (text)frame should flow.

Definition at line 103 of file KWFrame.h.

void KWFrame::saveOdf ( KoShapeSavingContext &  context  ) 

Save the frame as ODF.

Parameters:
context the context for saving.

Definition at line 86 of file KWFrame.cpp.

void KWFrame::setFrameBehavior ( KWord::FrameBehavior  fb  )  [inline]

Set what should happen when the frame is full.

Parameters:
fb the new FrameBehavior

Definition at line 65 of file KWFrame.h.

void KWFrame::setFrameOnBothSheets ( bool  both  )  [inline]

Determines if this frame will be copied on even or odd pages only.

Altering this does not change the frames placed until a new page is created.

Parameters:
both if true this frame will be copied to every page, if false only every other page

Definition at line 81 of file KWFrame.h.

void KWFrame::setFrameSet ( KWFrameSet *  newFrameSet  )  [virtual]

Set the frameset this frame will work on.

Altering the frameset requires you to remove this frame on the old and add the frame on the new frameset

Parameters:
newFrameSet the new frameset

Definition at line 63 of file KWFrame.cpp.

void KWFrame::setNewFrameBehavior ( KWord::NewFrameBehavior  nf  )  [inline]

For frame duplication policy on new page creation.

Altering this does not change the frames placed until a new page is created.

Parameters:
nf the NewFrameBehavior.

Definition at line 96 of file KWFrame.h.

void KWFrame::setOutlineShape ( KWOutlineShape *  outline  ) 

Definition at line 112 of file KWFrame.cpp.

void KWFrame::setRunAroundDistance ( qreal  distance  )  [inline]

Set the space between this frames edge and the text when that text runs around this frame.

Parameters:
distance the space around this frame to keep free from text

Definition at line 142 of file KWFrame.h.

void KWFrame::setRunAroundSide ( KWord::RunAroundSide  side  )  [inline]

Set the side around text from another (text)frame should flow.

Parameters:
side the requested side

Definition at line 110 of file KWFrame.h.

void KWFrame::setShape ( KoShape *  shape  )  [protected]

replace the current set shape with the argument one.

Definition at line 96 of file KWFrame.cpp.

void KWFrame::setTextRunAround ( KWord::TextRunAround  runAround  )  [inline]

Set the text runaround property for this frame.

This property specifies how text from another textframe will behave when this frame intersects with it.

Definition at line 127 of file KWFrame.h.

KoShape* KWFrame::shape (  )  const [inline]

Each frame will be rendered by a shape which also holds the position etc.

Returns:
the shape that represents this frame.

Definition at line 150 of file KWFrame.h.

KWord::TextRunAround KWFrame::textRunAround (  )  const [inline]

Return the text runaround property for this frame.

This property specifies how text from another textframe will behave when this frame intersects with it.

Definition at line 119 of file KWFrame.h.

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