QTextFrameFormat Class Reference

#include <qtextformat.h>

Class Description

Definition at line 727 of file qtextformat.h.

Inheritance diagram for QTextFrameFormat:

Public Types
enum	Position { InFlow, FloatLeft, FloatRight }
enum	BorderStyle {   BorderStyle_None, BorderStyle_Dotted, BorderStyle_Dashed, BorderStyle_Solid,   BorderStyle_Double, BorderStyle_DotDash, BorderStyle_DotDotDash, BorderStyle_Groove,   BorderStyle_Ridge, BorderStyle_Inset, BorderStyle_Outset }
Public Types inherited from QTextFormat
enum	FormatType {   InvalidFormat = -1, BlockFormat = 1, CharFormat = 2, ListFormat = 3,   TableFormat = 4, FrameFormat = 5, UserFormat = 100 }
enum	Property {   ObjectIndex = 0x0, CssFloat = 0x0800, LayoutDirection = 0x0801, OutlinePen = 0x810,   BackgroundBrush = 0x820, ForegroundBrush = 0x821, BackgroundImageUrl = 0x823, BlockAlignment = 0x1010,   BlockTopMargin = 0x1030, BlockBottomMargin = 0x1031, BlockLeftMargin = 0x1032, BlockRightMargin = 0x1033,   TextIndent = 0x1034, TabPositions = 0x1035, BlockIndent = 0x1040, LineHeight = 0x1048,   LineHeightType = 0x1049, BlockNonBreakableLines = 0x1050, BlockTrailingHorizontalRulerWidth = 0x1060, FirstFontProperty = 0x1FE0,   FontCapitalization = FirstFontProperty, FontLetterSpacing = 0x1FE1, FontWordSpacing = 0x1FE2, FontStyleHint = 0x1FE3,   FontStyleStrategy = 0x1FE4, FontKerning = 0x1FE5, FontHintingPreference = 0x1FE6, FontFamily = 0x2000,   FontPointSize = 0x2001, FontSizeAdjustment = 0x2002, FontSizeIncrement = FontSizeAdjustment, FontWeight = 0x2003,   FontItalic = 0x2004, FontUnderline = 0x2005, FontOverline = 0x2006, FontStrikeOut = 0x2007,   FontFixedPitch = 0x2008, FontPixelSize = 0x2009, LastFontProperty = FontPixelSize, TextUnderlineColor = 0x2010,   TextVerticalAlignment = 0x2021, TextOutline = 0x2022, TextUnderlineStyle = 0x2023, TextToolTip = 0x2024,   IsAnchor = 0x2030, AnchorHref = 0x2031, AnchorName = 0x2032, ObjectType = 0x2f00,   ListStyle = 0x3000, ListIndent = 0x3001, ListNumberPrefix = 0x3002, ListNumberSuffix = 0x3003,   FrameBorder = 0x4000, FrameMargin = 0x4001, FramePadding = 0x4002, FrameWidth = 0x4003,   FrameHeight = 0x4004, FrameTopMargin = 0x4005, FrameBottomMargin = 0x4006, FrameLeftMargin = 0x4007,   FrameRightMargin = 0x4008, FrameBorderBrush = 0x4009, FrameBorderStyle = 0x4010, TableColumns = 0x4100,   TableColumnWidthConstraints = 0x4101, TableCellSpacing = 0x4102, TableCellPadding = 0x4103, TableHeaderRowCount = 0x4104,   TableCellRowSpan = 0x4810, TableCellColumnSpan = 0x4811, TableCellTopPadding = 0x4812, TableCellBottomPadding = 0x4813,   TableCellLeftPadding = 0x4814, TableCellRightPadding = 0x4815, ImageName = 0x5000, ImageWidth = 0x5010,   ImageHeight = 0x5011, FullWidthSelection = 0x06000, PageBreakPolicy = 0x7000, UserProperty = 0x100000 }
enum	ObjectTypes {   NoObject, ImageObject, TableObject, TableCellObject,   UserObject = 0x1000 }
enum	PageBreakFlag { PageBreak_Auto = 0, PageBreak_AlwaysBefore = 0x001, PageBreak_AlwaysAfter = 0x010 }

Public Member Functions
	QTextFrameFormat ()
bool	isValid () const
void	setPosition (Position f)
Position	position () const
void	setBorder (qreal border)
qreal	border () const
void	setBorderBrush (const QBrush &brush)
QBrush	borderBrush () const
void	setBorderStyle (BorderStyle style)
BorderStyle	borderStyle () const
void	setMargin (qreal margin)
qreal	margin () const
void	setTopMargin (qreal margin)
qreal	topMargin () const
void	setBottomMargin (qreal margin)
qreal	bottomMargin () const
void	setLeftMargin (qreal margin)
qreal	leftMargin () const
void	setRightMargin (qreal margin)
qreal	rightMargin () const
void	setPadding (qreal padding)
qreal	padding () const
void	setWidth (qreal width)
void	setWidth (const QTextLength &length)
QTextLength	width () const
void	setHeight (qreal height)
void	setHeight (const QTextLength &height)
QTextLength	height () const
void	setPageBreakPolicy (PageBreakFlags flags)
PageBreakFlags	pageBreakPolicy () const
Public Member Functions inherited from QTextFormat
	QTextFormat ()
	QTextFormat (int type)
	QTextFormat (const QTextFormat &rhs)
QTextFormat &	operator= (const QTextFormat &rhs)
	~QTextFormat ()
void	merge (const QTextFormat &other)
bool	isValid () const
int	type () const
int	objectIndex () const
void	setObjectIndex (int object)
QVariant	property (int propertyId) const
void	setProperty (int propertyId, const QVariant &value)
void	clearProperty (int propertyId)
bool	hasProperty (int propertyId) const
bool	boolProperty (int propertyId) const
int	intProperty (int propertyId) const
qreal	doubleProperty (int propertyId) const
QString	stringProperty (int propertyId) const
QColor	colorProperty (int propertyId) const
QPen	penProperty (int propertyId) const
QBrush	brushProperty (int propertyId) const
QTextLength	lengthProperty (int propertyId) const
QVector< QTextLength >	lengthVectorProperty (int propertyId) const
void	setProperty (int propertyId, const QVector< QTextLength > &lengths)
QMap< int, QVariant >	properties () const
int	propertyCount () const
void	setObjectType (int type)
int	objectType () const
bool	isCharFormat () const
bool	isBlockFormat () const
bool	isListFormat () const
bool	isFrameFormat () const
bool	isImageFormat () const
bool	isTableFormat () const
bool	isTableCellFormat () const
QTextBlockFormat	toBlockFormat () const
QTextCharFormat	toCharFormat () const
QTextListFormat	toListFormat () const
QTextTableFormat	toTableFormat () const
QTextFrameFormat	toFrameFormat () const
QTextImageFormat	toImageFormat () const
QTextTableCellFormat	toTableCellFormat () const
bool	operator== (const QTextFormat &rhs) const
bool	operator!= (const QTextFormat &rhs) const
	operator QVariant () const
void	setLayoutDirection (Qt::LayoutDirection direction)
Qt::LayoutDirection	layoutDirection () const
void	setBackground (const QBrush &brush)
QBrush	background () const
void	clearBackground ()
void	setForeground (const QBrush &brush)
QBrush	foreground () const
void	clearForeground ()

Protected Member Functions
	QTextFrameFormat (const QTextFormat &fmt)

Friends
class	QTextFormat

Member Enumeration Documentation

enum Position

Enumerator
InFlow
FloatLeft
FloatRight

Definition at line 734 of file qtextformat.h.

                  {
        InFlow,
        FloatLeft,
        FloatRight
        // ######
//        Absolute
    };

enum BorderStyle

Enumerator
BorderStyle_None
BorderStyle_Dotted
BorderStyle_Dashed
BorderStyle_Solid
BorderStyle_Double
BorderStyle_DotDash
BorderStyle_DotDotDash
BorderStyle_Groove
BorderStyle_Ridge
BorderStyle_Inset
BorderStyle_Outset

Definition at line 742 of file qtextformat.h.

                     {
        BorderStyle_None,
        BorderStyle_Dotted,
        BorderStyle_Dashed,
        BorderStyle_Solid,
        BorderStyle_Double,
        BorderStyle_DotDash,
        BorderStyle_DotDotDash,
        BorderStyle_Groove,
        BorderStyle_Ridge,
        BorderStyle_Inset,
        BorderStyle_Outset
    };

Constructor & Destructor Documentation

QTextFrameFormat

(

)

QTextFrameFormat ( const QTextFormat &  fmt )

explicitprotected

Member Function Documentation

bool isValid ( ) const

inline

Definition at line 732 of file qtextformat.h.

{ return isFrameFormat(); }

void setPosition ( Position  f )

inline

Definition at line 756 of file qtextformat.h.

    { setProperty(CssFloat, f); }

Position position ( ) const

inline

Definition at line 758 of file qtextformat.h.

    { return static_cast<Position>(intProperty(CssFloat)); }

void setBorder ( qreal  border )

inline

Definition at line 816 of file qtextformat.h.

{ setProperty(FrameBorder, aborder); }

qreal border ( ) const

inline

Definition at line 762 of file qtextformat.h.

    { return doubleProperty(FrameBorder); }

void setBorderBrush ( const QBrush &  brush )

inline

Definition at line 765 of file qtextformat.h.

    { setProperty(FrameBorderBrush, brush); }

QBrush borderBrush ( ) const

inline

Definition at line 767 of file qtextformat.h.

    { return brushProperty(FrameBorderBrush); }

void setBorderStyle ( BorderStyle  style )

inline

Definition at line 770 of file qtextformat.h.

    { setProperty(FrameBorderStyle, style); }

BorderStyle borderStyle ( ) const

inline

Definition at line 772 of file qtextformat.h.

    { return static_cast<BorderStyle>(intProperty(FrameBorderStyle)); }

void setMargin

(

qreal

margin

)

qreal margin ( ) const

inline

Definition at line 776 of file qtextformat.h.

    { return doubleProperty(FrameMargin); }

void setTopMargin ( qreal  margin )

inline

Definition at line 830 of file qtextformat.h.

{ setProperty(FrameTopMargin, amargin); }

qreal topMargin

(

)

const

void setBottomMargin ( qreal  margin )

inline

Definition at line 833 of file qtextformat.h.

{ setProperty(FrameBottomMargin, amargin); }

qreal bottomMargin

(

)

const

void setLeftMargin ( qreal  margin )

inline

Definition at line 836 of file qtextformat.h.

{ setProperty(FrameLeftMargin, amargin); }

qreal leftMargin

(

)

const

void setRightMargin ( qreal  margin )

inline

Definition at line 839 of file qtextformat.h.

{ setProperty(FrameRightMargin, amargin); }

qreal rightMargin

(

)

const

void setPadding ( qreal  padding )

inline

Definition at line 819 of file qtextformat.h.

{ setProperty(FramePadding, apadding); }

qreal padding ( ) const

inline

Definition at line 792 of file qtextformat.h.

    { return doubleProperty(FramePadding); }

void setWidth ( qreal  width )

inline

Definition at line 822 of file qtextformat.h.

{ setProperty(FrameWidth, QTextLength(QTextLength::FixedLength, awidth)); }

void setWidth ( const QTextLength &  length )

inline

Definition at line 796 of file qtextformat.h.

    { setProperty(FrameWidth, length); }

QTextLength width ( ) const

inline

Definition at line 798 of file qtextformat.h.

    { return lengthProperty(FrameWidth); }

void setHeight ( qreal  height )

inline

Definition at line 825 of file qtextformat.h.

{ setProperty(FrameHeight, QTextLength(QTextLength::FixedLength, aheight)); }

void setHeight ( const QTextLength &  height )

inline

Definition at line 827 of file qtextformat.h.

{ setProperty(FrameHeight, aheight); }

QTextLength height ( ) const

inline

Definition at line 803 of file qtextformat.h.

    { return lengthProperty(FrameHeight); }

void setPageBreakPolicy ( PageBreakFlags  flags )

inline

Definition at line 806 of file qtextformat.h.

    { setProperty(PageBreakPolicy, int(flags)); }

PageBreakFlags pageBreakPolicy ( ) const

inline

Definition at line 808 of file qtextformat.h.

    { return PageBreakFlags(intProperty(PageBreakPolicy)); }

Friends And Related Function Documentation

friend class QTextFormat

friend

Definition at line 813 of file qtextformat.h.

---

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

• QtGui/qtextformat.h