kword/part

KWord Namespace Reference

The kword-global namespace for all KWord related things. More...

Enumerations

enum  FootNoteSeparatorLinePos { FootNoteSeparatorLeft, FootNoteSeparatorCenter, FootNoteSeparatorRight }
enum  FrameBehavior { AutoExtendFrameBehavior, AutoCreateNewFrameBehavior, IgnoreContentFrameBehavior }
enum  HeaderFooterType { HFTypeNone, HFTypeEvenOdd, HFTypeUniform }
enum  KWordCanvasResources {
  CurrentFrame = KoCanvasResource::KWordStart, CurrentFrameSet, CurrentFrameSetCount, CurrentPictureCount,
  CurrentTableCount, CurrentPageCount, FrameOutlineColor
}
enum  NewFrameBehavior { ReconnectNewFrame, NoFollowupFrame, CopyNewFrame }
enum  RunAroundSide {
  BiggestRunAroundSide, LeftRunAroundSide, RightRunAroundSide, AutoRunAroundSide,
  BothRunAroundSide
}
enum  TextFrameSetType {
  OddPagesHeaderTextFrameSet, EvenPagesHeaderTextFrameSet, OddPagesFooterTextFrameSet, EvenPagesFooterTextFrameSet,
  MainTextFrameSet, OtherTextFrameSet
}
enum  TextRunAround { NoRunAround, RunAround, RunThrough }

Functions

bool isAutoGenerated (KWTextFrameSet *fs)
bool isHeaderFooter (KWTextFrameSet *fs)

Detailed Description

The kword-global namespace for all KWord related things.

Enumeration Type Documentation

enum KWord::FootNoteSeparatorLinePos

Specifies the horizontal position of the line that separates main text and foot note.

Enumerator:
FootNoteSeparatorLeft 

Left of page.

FootNoteSeparatorCenter 

Centered on page.

FootNoteSeparatorRight 

Right of page.

Definition at line 93 of file KWord.h.

enum KWord::FrameBehavior

what should happen when the frame is full (too small for its contents)

Enumerator:
AutoExtendFrameBehavior 

Make the frame bigger to fit the contents.

AutoCreateNewFrameBehavior 

Create a new frame on the next page.

IgnoreContentFrameBehavior 

Ignore the content and clip it.

Definition at line 33 of file KWord.h.

enum KWord::HeaderFooterType

used in KWPageSettings to determine if, and what kind of header/footer to use

Enumerator:
HFTypeNone 

Don't show the frames.

HFTypeEvenOdd 

Show different content for even and odd pages.

HFTypeUniform 

Show the same content for each page.

Definition at line 86 of file KWord.h.

enum KWord::KWordCanvasResources

Specifies the KWord specific resources that you can put and get from the KoCanvasResourceProvider.

Enumerator:
CurrentFrame 
CurrentFrameSet 
CurrentFrameSetCount 
CurrentPictureCount 
CurrentTableCount 
CurrentPageCount 
FrameOutlineColor 

Definition at line 100 of file KWord.h.

enum KWord::NewFrameBehavior

What happens on new page.

Enumerator:
ReconnectNewFrame 

On new page reconnect a copied from to the flow.

NoFollowupFrame 

On new page don't create a new page.

CopyNewFrame 

On new page create a copy-frame and show that.

Definition at line 39 of file KWord.h.

enum KWord::RunAroundSide

The behavior other frames' text has when this property is set on a frame.

Enumerator:
BiggestRunAroundSide 

Run other text around the side that has the most space.

LeftRunAroundSide 

Run other text around the left side of the frame.

RightRunAroundSide 

Run other text around the right side of the frame.

AutoRunAroundSide 

Run other text dynamically around both sides of the shape, provided there is sufficient space left.

BothRunAroundSide 

Run other text around both sides of the shape.

Definition at line 46 of file KWord.h.

enum KWord::TextFrameSetType

Each text frame set can be catogorized in one of these items.

Enumerator:
OddPagesHeaderTextFrameSet 

The frameSet that holds the headers for the odd pages.

EvenPagesHeaderTextFrameSet 

The frameSet that holds the headers for the even pages.

OddPagesFooterTextFrameSet 

The frameSet that holds the footers for the odd pages.

EvenPagesFooterTextFrameSet 

The frameSet that holds the footers for the even pages.

MainTextFrameSet 

The frameset that holds all the frames for the main text area.

OtherTextFrameSet 

Any other text frameset not managed by the auto-frame layout.

Definition at line 76 of file KWord.h.

enum KWord::TextRunAround

This property specifies how text from a text frame behaves when a frame with one of these properties set on it intersects with it.

Enumerator:
NoRunAround 

The text will be completely avoiding the frame by keeping the horizontal space that this frame occupies blank.

RunAround 

The text will run around the outline of the frame.

RunThrough 

The text will completely ignore the frame and layout as if it was not there.

Definition at line 58 of file KWord.h.

Function Documentation

bool KWord::isAutoGenerated ( KWTextFrameSet *  fs  ) 

Returns true if the passed frameset is a known type that the frameLayout auto-creates.

Parameters:
fs the frameset to check. 0 is allowed.
bool KWord::isHeaderFooter ( KWTextFrameSet *  fs  ) 

Returns true if the passed frameset is a header or a footer frameset.

Parameters:
fs the frameset to check. 0 is allowed.