kword/part
KWTextFrame Class Reference
A single frame capable of showing text from a KWTextFrameSet. More...
#include <KWTextFrame.h>
Public Member Functions | |
| KWTextFrame (KoShape *shape, KWTextFrameSet *parent, int pageNumber=-1) | |
| ~KWTextFrame () | |
| void | allowToGrow () |
| void | autoShrink (qreal requestedHeight) |
| bool | canAutoGrow () |
| qreal | minimumFrameHeight () const |
| void | setMinimumFrameHeight (qreal minimumFrameHeight) |
| void | setSortingId (int id) |
| int | sortingId () const |
Detailed Description
A single frame capable of showing text from a KWTextFrameSet.
Definition at line 34 of file KWTextFrame.h.
Constructor & Destructor Documentation
| KWTextFrame::KWTextFrame | ( | KoShape * | shape, | |
| KWTextFrameSet * | parent, | |||
| int | pageNumber = -1 | |||
| ) |
Constructor.
- Parameters:
-
shape a ready made shape that is capable of showing text This shape should be created using a KoShapeFactory from the textShape plugin parent the frameSet this frame will be associated with.
Definition at line 28 of file KWTextFrame.cpp.
| KWTextFrame::~KWTextFrame | ( | ) |
Definition at line 37 of file KWTextFrame.cpp.
Member Function Documentation
| void KWTextFrame::allowToGrow | ( | ) |
A layout property. Marks the frame able to get bigger when there is more text to fit.
Definition at line 52 of file KWTextFrame.cpp.
| void KWTextFrame::autoShrink | ( | qreal | requestedHeight | ) |
A layout option. Asks the frame to shrink to a maximum of requestedHeight because there is no more text.
Definition at line 58 of file KWTextFrame.cpp.
| bool KWTextFrame::canAutoGrow | ( | ) |
A layout property. Return if the frame can autogrow.
- See also:
- allowToGrow
Definition at line 41 of file KWTextFrame.cpp.
| qreal KWTextFrame::minimumFrameHeight | ( | ) | const [inline] |
Definition at line 77 of file KWTextFrame.h.
| void KWTextFrame::setMinimumFrameHeight | ( | qreal | minimumFrameHeight | ) | [inline] |
Definition at line 76 of file KWTextFrame.h.
| void KWTextFrame::setSortingId | ( | int | id | ) | [inline] |
Set the sorting id of the frame in the frameset.
- Parameters:
-
id of sorting, where -1 means sorting based on position, and heigher means later in the sequence.
- See also:
- sortingId()
Definition at line 65 of file KWTextFrame.h.
| int KWTextFrame::sortingId | ( | ) | const [inline] |
Set the sorting Id that influences the sorting order of the text frames.
Text frames have an order in which they are used to flow the text in, this typically is from top/left to bottom/right in the document in contrary to order of insertion. Since KWord2 the sorting Id is used to allow frames to have an explicit position in the list of frames and thus the ordering of the text.
- Returns:
- the id of sorting, where -1 means sorting based on position, and heigher means later in the sequence.
Definition at line 56 of file KWTextFrame.h.
The documentation for this class was generated from the following files:
