#include <pageitem.h>

Inheritance diagram for PageItem:

Collaboration diagram for PageItem:

Classes
struct	WeldingInfo

Public Types
enum	DrawOption { NoRotation = 1, NoSoftShadow = 2 }
	Draw options for DrawObj_toImage() More...

enum	ItemType { ItemType1 = 1, ImageFrame = 2, ItemType3 = 3, TextFrame = 4, Line = 5, Polygon = 6, PolyLine = 7, PathText = 8, LatexFrame = 9, OSGFrame = 10, Symbol = 11, Group = 12, RegularPolygon = 13, Arc = 14, Spiral = 15, Table = 16, Multiple = 99 }
	Item Type. More...

enum	TextFlowMode { TextFlowDisabled = 0, TextFlowUsesFrameShape = 1, TextFlowUsesBoundingBox = 2, TextFlowUsesContourLine = 3, TextFlowUsesImageClipping = 4 }
	Text flow mode. More...

enum	ItemFrameType { Unspecified =-1, Rectangle = 0, Ellipse = 1, Round = 2, Other = 3 }
	Frame Type.

Signals
void	myself (PageItem *)

void	frameType (int)
	not related to Frametype but to m_itemIype

void	textStyle (int)

Public Member Functions
	PageItem (ScribusDoc *pa, ItemType newType, double x, double y, double w, double h, double w2, QString fill, QString outline)

virtual PageItem_Arc *	asArc ()
	Return self if Arc item, otherwise null.

virtual PageItem_Group *	asGroupFrame ()
	Return self if Group item, otherwise null.

virtual PageItem_ImageFrame *	asImageFrame ()
	Return self if Image item, otherwise null.

virtual PageItem_LatexFrame *	asLatexFrame ()
	Return self if Render frame item, otherwise null.

virtual PageItem_Line *	asLine ()
	Return self if Line item, otherwise null.

virtual PageItem_NoteFrame *	asNoteFrame ()
	Return self if Note item, otherwise null.

virtual PageItem_OSGFrame *	asOSGFrame ()
	Return self if OSG item, otherwise null.

virtual PageItem_PathText *	asPathText ()
	Return self if Path Text item, otherwise null.

virtual PageItem_PolyLine *	asPolyLine ()
	Return self if Poly Line item, otherwise null.

virtual PageItem_Polygon *	asPolygon ()
	Return self if Polygon item, otherwise null.

virtual PageItem_RegularPolygon *	asRegularPolygon ()
	Return self if Regular Polygon item, otherwise null.

virtual PageItem_Spiral *	asSpiral ()
	Return self if Spiral item, otherwise null.

virtual PageItem_Symbol *	asSymbolFrame ()
	Return self if Symbol item, otherwise null.

virtual PageItem_Table *	asTable ()
	Return self if Table item, otherwise null.

virtual PageItem_TextFrame *	asTextFrame ()
	Return self if Text item, otherwise null.

virtual bool	isArc () const
	Return true if Arc item, otherwise false.

virtual bool	isAutoNoteFrame () const
	Return true if Auto Note item, otherwise false.

virtual bool	isGroup () const
	Return true if Group item, otherwise false.

virtual bool	isImageFrame () const
	Return true if Image item, otherwise false.

virtual bool	isLatexFrame () const
	Return true if Render frame item, otherwise false.

virtual bool	isLine () const
	Return true if Line item, otherwise false.

virtual bool	isNoteFrame () const
	Return true if Note item, otherwise false.

virtual bool	isOSGFrame () const
	Return true if OSG item, otherwise false.

virtual bool	isPathText () const
	Return true if Text Path Text, otherwise false.

virtual bool	isPolyLine () const
	Return true if Poly Line item, otherwise false.

virtual bool	isPolygon () const
	Return true if Polygon item, otherwise false.

virtual bool	isRegularPolygon () const
	Return true if Regular Polygon item, otherwise false.

virtual bool	isSpiral () const
	Return true if Spiral item, otherwise false.

virtual bool	isSymbol () const
	Return true if Symbol item, otherwise false.

virtual bool	isTable () const
	Return true if Table item, otherwise false.

virtual bool	isTextFrame () const
	Return true if Text item, otherwise false.

virtual bool	isGroupChild () const

virtual bool	isTableCell () const

PageItem_Group *	parentGroup () const

PageItem_Table *	parentTable () const

virtual void	applicableActions (QStringList &actionList)=0

virtual QString	infoDescription ()

virtual bool	createInfoGroup (QFrame , QGridLayout )

void	DrawObj (ScPainter *p, QRectF e)

void	DrawObj_Pre (ScPainter *p)

virtual void	DrawObj_Post (ScPainter *p)

virtual void	DrawObj_Decoration (ScPainter *p)

virtual void	DrawObj_Item (ScPainter *p, QRectF e)=0

QImage	DrawObj_toImage (double maxSize, int options=0)

QImage	DrawObj_toImage (QList< PageItem * > &emG, double scaling)

void	DrawObj_Embedded (ScPainter p, QRectF e, const CharStyle &style, PageItem cembedded)

void	DrawStrokePattern (ScPainter *p, QPainterPath &path)

void	DrawSoftShadow (ScPainter *p)

QRect	getRedrawBounding (const double)
	Set or get the redraw bounding box of the item, moved from the View.

void	setRedrawBounding ()

void	setPolyClip (int up, int down=0)

void	updatePolyClip ()

void	updateClip (bool updateWelded=true)

void	convertClip ()

QRectF	getBoundingRect () const

QRectF	getCurrentBoundingRect (double moreSpace=0.0) const

QRectF	getVisualBoundingRect () const

virtual void	getBoundingRect (double x1, double y1, double x2, double y2) const

virtual void	getVisualBoundingRect (double x1, double y1, double x2, double y2) const

virtual void	clearContents ()
	Clear the contents of a frame. WARNING: Currently they do not check if the user wants this. The view does when these are called.

virtual void	truncateContents ()

bool	pointWithinItem (const int x, const int y) const
	Check if a QPoint is within the items boundaries No coordinates transformation is performed. More...

bool	mouseWithinItem (const int x, const int y, double scale) const
	Check if the mouse is within the items boundaries This method performs necessary page to device transformations. More...

virtual void	handleModeEditKey (QKeyEvent *k, bool &keyRepeat)

int	level () const
	Get item level relative to its parent doc or group.

void	saxx (SaxHandler &handler, const Xml_string &elemtag) const

void	saxx (SaxHandler &handler) const

void	AdjustPictScale ()
	Adjust the picture scale, moved from the view, no view code here FIXME: Move to PageItem_TextFrame.

void	updateGradientVectors ()
	Update the gradient vectors, moved from the View.

void	moveImageInFrame (double newX, double newY)
	Move the image within the frame Old ScribusView::MoveItemI. More...

ObjAttrVector *	getObjectAttributes ()

QList< ObjectAttribute >	getObjectAttributes (QString attributeName) const

ObjectAttribute	getObjectAttribute (QString) const

void	setObjectAttributes (ObjAttrVector *)

void	SetFrameShape (int count, double *vals)

void	SetRectFrame ()

void	SetOvalFrame ()

void	SetFrameRound ()

QTransform	getGroupTransform () const

void	getTransform (QTransform &mat) const

QTransform	getTransform () const

virtual void	invalidateLayout ()
	invalidates current layout information

virtual void	layout ()
	creates valid layout information

PageItem *	frameTextEnd ()
	returns frame where is text end

bool	frameOverflows () const
	returns true if text overflows

bool	frameUnderflows () const
	returns true if text is ending before that frame

int	frameOverflowCount () const

int	frameOverflowBlankCount () const

void	drawOverflowMarker (ScPainter *p)
	Draws the overflow marker.

int	firstInFrame () const
	returns index of first char displayed in this frame, used to be 0

int	lastInFrame () const
	returns index of last char displayed in this frame, used to be MaxChars-1

bool	frameDisplays (int textpos) const
	tests if a character is displayed by this fram More...

const ParagraphStyle &	currentStyle () const
	returns the style at the current charpos

ParagraphStyle &	changeCurrentStyle ()
	returns the style at the current charpos for changing More...

const CharStyle &	currentCharStyle () const
	returns the style at the current charpos

void	currentTextProps (ParagraphStyle &parStyle) const
	Return current text properties (current char + paragraph properties)

double	layoutGlyphs (const CharStyle &style, const QString &chars, LayoutFlags flags, GlyphLayout &layout)

void	SetQColor (QColor *tmp, QString farbe, double shad)

void	drawGlyphs (ScPainter *p, const CharStyle &style, LayoutFlags flags, GlyphLayout &glyphs)

void	DrawPolyL (QPainter *p, QPolygon pts)

QString	ExpandToken (uint base)

const FPointArray	shape () const

void	setShape (FPointArray val)

const FPointArray	contour () const

void	setContour (FPointArray val)

bool	flipPathText () const

void	setFlipPathText (bool val)

int	pathTextType () const

void	setPathTextType (int val)

double	pathTextBaseOffset () const

void	setPathTextBaseOffset (double val)

bool	pathTextShowFrame () const

void	setPathTextShowFrame (bool val)

bool	useEmbeddedImageProfile () const

void	setUseEmbeddedImageProfile (bool val)

QString	embeddedImageProfile () const

void	setEmbeddedImageProfile (QString val)

bool	drawFrame ()

QString	externalFile () const

void	setExternalFile (QString val)

void	setImagePagenumber (int num)

void	setResolution (int)

QString	fileIconPressed () const

void	setFileIconPressed (QString val)

QString	fileIconRollover () const

void	setFileIconRollover (QString val)

int	cmsRenderingIntent () const

void	setCmsRenderingIntent (eRenderIntent val)

QString	cmsProfile () const

void	setCmsProfile (QString val)

void	setOverrideCompressionMethod (bool val)

void	setCompressionMethodIndex (int val)

void	setOverrideCompressionQuality (bool val)

void	setCompressionQualityIndex (int val)

PageItem *	prevInChain ()

PageItem *	nextInChain ()

const PageItem *	prevInChain () const

const PageItem *	nextInChain () const

PageItem *	firstInChain ()

PageItem *	lastInChain ()

bool	testLinkCandidate (PageItem *nextFrame)

void	unlink (bool createUndo=true)

void	link (PageItem *nextFrame, bool addPARSEP=true)

void	dropLinks ()

void	unlinkWithText (bool)

void	setSampleItem (bool b)

const QVector< double > &	dashes () const

QVector< double > &	dashes ()

void	setDashes (QVector< double > val)

double	dashOffset () const

void	setDashOffset (double val)

virtual QList< PageItem * >	getItemList ()

double	xPos () const

double	yPos () const

double	visualXPos () const

double	visualYPos () const

FPoint	xyPos () const

void	setXPos (const double, bool drawingOnly=false)

void	setYPos (const double, bool drawingOnly=false)

void	setXYPos (const double, const double, bool drawingOnly=false)

void	moveBy (const double, const double, bool drawingOnly=false)

double	width () const

double	height () const

double	visualWidth () const

double	visualHeight () const

double	visualLineWidth ()

void	setWidth (const double)

void	setHeight (const double)

void	setWidthHeight (const double, const double, bool drawingOnly)

void	setWidthHeight (const double, const double)

void	resizeBy (const double, const double)

double	rotation () const

void	setRotation (const double, bool drawingOnly)

void	setRotation (const double r)
	needed for deSaXe

void	rotateBy (const double)

bool	isSelected () const

void	setSelected (const bool)

double	imageXScale () const

double	imageYScale () const

void	setImageXScale (const double)

void	setImageYScale (const double)

void	setImageXYScale (const double, const double)

double	imageXOffset () const

double	imageYOffset () const

void	setImageXOffset (const double)

void	setImageYOffset (const double)

void	moveImageXYOffsetBy (const double, const double)

void	setImageXYOffset (const double, const double)

double	imageRotation () const

void	setImageRotation (const double newRotation)

bool	reversed () const

void	setReversed (bool)

double	cornerRadius () const

void	setCornerRadius (double)

bool	isPDFBookmark () const

void	setIsPDFBookmark (bool val)

int	gradientType () const
	0=none, 1,2,3,4=linear, 5=radial, 6=free linear, 7=free radial, 8=pattern

void	setGradientType (int val)

double	gradientStartX () const

void	setGradientStartX (double val)

double	gradientStartY () const

void	setGradientStartY (double val)

double	gradientEndX () const

void	setGradientEndX (double val)

double	gradientEndY () const

void	setGradientEndY (double val)

double	gradientFocalX () const

void	setGradientFocalX (double val)

double	gradientFocalY () const

void	setGradientFocalY (double val)

double	gradientScale () const

void	setGradientScale (double val)

double	gradientSkew () const

void	setGradientSkew (double val)

double	gradientMaskStartX () const

void	setGradientMaskStartX (double val)

double	gradientMaskStartY () const

void	setGradientMaskStartY (double val)

double	gradientMaskEndX () const

void	setGradientMaskEndX (double val)

double	gradientMaskEndY () const

void	setGradientMaskEndY (double val)

double	gradientMaskFocalX () const

void	setGradientMaskFocalX (double val)

double	gradientMaskFocalY () const

void	setGradientMaskFocalY (double val)

double	gradientMaskScale () const

void	setGradientMaskScale (double val)

double	gradientMaskSkew () const

void	setGradientMaskSkew (double val)

FPoint	gradientControl1 () const

void	setGradientControl1 (FPoint val)

FPoint	gradientControl2 () const

void	setGradientControl2 (FPoint val)

FPoint	gradientControl3 () const

void	setGradientControl3 (FPoint val)

FPoint	gradientControl4 () const

void	setGradientControl4 (FPoint val)

FPoint	gradientControl5 () const

void	setGradientControl5 (FPoint val)

double	gradientStrokeScale () const

void	setGradientStrokeScale (double val)

double	gradientStrokeSkew () const

void	setGradientStrokeSkew (double val)

double	gradientStrokeFocalX () const

void	setGradientStrokeFocalX (double val)

double	gradientStrokeFocalY () const

void	setGradientStrokeFocalY (double val)

double	gradientStrokeStartX () const

void	setGradientStrokeStartX (double val)

double	gradientStrokeStartY () const

void	setGradientStrokeStartY (double val)

double	gradientStrokeEndX () const

void	setGradientStrokeEndX (double val)

double	gradientStrokeEndY () const

void	setGradientStrokeEndY (double val)

QString	gradientCol1 () const

void	setGradientCol1 (QString val)

QString	gradientCol2 () const

void	setGradientCol2 (QString val)

QString	gradientCol3 () const

void	setGradientCol3 (QString val)

QString	gradientCol4 () const

void	setGradientCol4 (QString val)

double	gradientTransp1 () const

void	setGradientTransp1 (double val)

double	gradientTransp2 () const

void	setGradientTransp2 (double val)

double	gradientTransp3 () const

void	setGradientTransp3 (double val)

double	gradientTransp4 () const

void	setGradientTransp4 (double val)

int	gradientShade1 () const

void	setGradientShade1 (int val)

int	gradientShade2 () const

void	setGradientShade2 (int val)

int	gradientShade3 () const

void	setGradientShade3 (int val)

int	gradientShade4 () const

void	setGradientShade4 (int val)

QColor	gradientColor1 () const

void	setGradientColor1 (QColor val)

QColor	gradientColor2 () const

void	setGradientColor2 (QColor val)

QColor	gradientColor3 () const

void	setGradientColor3 (QColor val)

QColor	gradientColor4 () const

void	setGradientColor4 (QColor val)

void	setGradientExtend (VGradient::VGradientRepeatMethod val)

void	setStrokeGradientExtend (VGradient::VGradientRepeatMethod val)

VGradient::VGradientRepeatMethod	getGradientExtend ()

VGradient::VGradientRepeatMethod	getStrokeGradientExtend ()

bool	getSnapToPatchGrid () const

void	setSnapToPatchGrid (bool val)

void	setMaskGradient (VGradient grad)

void	setFillGradient (VGradient grad)

void	setStrokeGradient (VGradient grad)

void	set4ColorGeometry (FPoint c1, FPoint c2, FPoint c3, FPoint c4)

void	set4ColorTransparency (double t1, double t2, double t3, double t4)

void	set4ColorShade (int t1, int t2, int t3, int t4)

void	set4ColorColors (QString col1, QString col2, QString col3, QString col4)

void	get4ColorGeometry (FPoint &c1, FPoint &c2, FPoint &c3, FPoint &c4)

void	setDiamondGeometry (FPoint c1, FPoint c2, FPoint c3, FPoint c4, FPoint c5)

void	get4ColorTransparency (double &t1, double &t2, double &t3, double &t4)

void	get4ColorColors (QString &col1, QString &col2, QString &col3, QString &col4)

void	setMeshPointColor (int x, int y, QString color, int shade, double transparency, bool forPatch=false)

void	createGradientMesh (int rows, int cols)

void	resetGradientMesh ()

void	meshToShape ()

void	createConicalMesh ()

VColorStop	computeInBetweenStop (VColorStop last, VColorStop actual, double t)

void	gradientVector (double &startX, double &startY, double &endX, double &endY, double &focalX, double &focalY, double &scale, double &skew) const

void	setGradientVector (double startX, double startY, double endX, double endY, double focalX, double focalY, double scale, double skew)

int	strokeGradientType () const

void	setStrokeGradientType (int val)

void	strokeGradientVector (double &startX, double &startY, double &endX, double &endY, double &focalX, double &focalY, double &scale, double &skew) const

void	setStrokeGradientVector (double startX, double startY, double endX, double endY, double focalX, double focalY, double scale, double skew)

int	maskType () const

void	setMaskType (int val)

void	setGradientMask (const QString &newMask)

void	setPatternMask (const QString &newMask)

QString	gradientMask () const

QString	patternMask () const

void	maskVector (double &startX, double &startY, double &endX, double &endY, double &focalX, double &focalY, double &scale, double &skew) const

void	setMaskVector (double startX, double startY, double endX, double endY, double focalX, double focalY, double scale, double skew)

void	maskTransform (double &scaleX, double &scaleY, double &offsetX, double &offsetY, double &rotation, double &skewX, double &skewY) const

void	setMaskTransform (double scaleX, double scaleY, double offsetX, double offsetY, double rotation, double skewX, double skewY)

void	setMaskFlip (bool flipX, bool flipY)

void	maskFlip (bool &flipX, bool &flipY)

bool	fillEvenOdd () const

void	setFillEvenOdd (bool val)

bool	overprint () const

void	setOverprint (bool val)

void	setHasSoftShadow (bool val)

bool	hasSoftShadow ()

void	setSoftShadowColor (const QString &val)

QString	softShadowColor ()

void	setSoftShadowShade (int val)

int	softShadowShade ()

void	setSoftShadowBlurRadius (double val)

double	softShadowBlurRadius ()

void	setSoftShadowXOffset (double val)

double	softShadowXOffset ()

void	setSoftShadowYOffset (double val)

double	softShadowYOffset ()

void	setSoftShadowOpacity (double val)

double	softShadowOpacity ()

void	setSoftShadowBlendMode (int val)

double	softShadowBlendMode ()

void	setSoftShadowErasedByObject (bool val)

bool	softShadowErasedByObject ()

void	setSoftShadowHasObjectTransparency (bool val)

bool	softShadowHasObjectTransparency ()

int	frameType () const
	rect / oval / round / other

void	setFrameType (int val)

bool	hasDefaultShape () const

void	setHasDefaultShape (bool val)

bool	isAutoFrame () const

void	setIsAutoFrame (bool val)

bool	keepAspectRatio () const

void	setKeepAspectRatio (bool val)

bool	fitImageToFrame () const

void	setFitImageToFrame (bool val)

bool	isImageInline () const

void	setImageInline (bool val)

void	setInlineExt (QString val)

void	setInlineData (QString data)

void	makeImageInline ()

void	makeImageExternal (QString path)

double	textToFrameDistLeft () const

double	textToFrameDistRight () const

double	textToFrameDistTop () const

double	textToFrameDistBottom () const

int	columns () const

double	columnGap () const

double	gridOffset () const

double	gridDistance () const

int	verticalAlignment ()

void	setTextToFrameDistLeft (double)

void	setTextToFrameDistRight (double)

void	setTextToFrameDistTop (double)

void	setTextToFrameDistBottom (double)

void	setColumns (int)

void	setColumnGap (double)

void	setGridOffset (double)

void	setGridDistance (double)

void	setVerticalAlignment (int)

FirstLineOffsetPolicy	firstLineOffset () const

void	setFirstLineOffset (FirstLineOffsetPolicy)

void	setTextToFrameDist (double newLeft, double newRight, double newTop, double newBottom)
	Set the text to frame distances all at once. More...

QString	itemName () const
	Get name of the item. More...

void	setItemName (const QString &newName)
	Set name of the item. More...

QString	gradient () const
	Get the name of the gradient of the object.

void	setGradient (const QString &newGradient)
	Set the fill gradient of the object. More...

QString	strokeGradient () const
	Get the name of the stroke gradient of the object.

void	setStrokeGradient (const QString &newGradient)
	Set the stroke gradient of the object. More...

QString	pattern () const
	Get the name of the pattern of the object.

void	patternTransform (double &scaleX, double &scaleY, double &offsetX, double &offsetY, double &rotation, double &skewX, double &skewY) const
	Get the pattern transformation matrix of the object.

void	setPattern (const QString &newPattern)
	Set the fill pattern of the object. More...

void	setPatternTransform (double scaleX, double scaleY, double offsetX, double offsetY, double rotation, double skewX, double skewY)
	Set the fill pattern transformation of the object.

void	setPatternFlip (bool flipX, bool flipY)

void	patternFlip (bool &flipX, bool &flipY)

QString	fillColor () const
	Get the (name of the) fill color of the object.

void	setFillColor (const QString &newColor)
	Set the fill color of the object. More...

double	fillShade () const
	Get the shade of the fill color.

void	setFillShade (double newShade)
	Set the fill color shade. More...

double	fillTransparency () const
	Get the transparency of the fill color.

void	setFillTransparency (double newTransparency)
	Set the transparency of the fill color. More...

int	fillBlendmode () const
	Get the blendmode of the fill color.

void	setFillBlendmode (int newBlendmode)
	Set the blendmode of the fill color. More...

int	lineBlendmode () const
	Get the blendmode of the stroke color.

void	setLineBlendmode (int newBlendmode)
	Set the blendmode of the stroke color. More...

QString	lineColor () const
	Get the line color of the object.

void	setLineColor (const QString &newColor)
	Set the line color of the object. More...

double	lineShade () const
	Get the line color shade.

void	setLineShade (double newShade)
	Set the line color shade. More...

double	lineTransparency () const
	Get the line transparency.

void	setLineTransparency (double newTransparency)
	Set the transparency of the line color. More...

void	setHatchParameters (int mode, double distance, double angle, bool useBackground, QString background, QString foreground)

QString	strokePattern () const
	Get the name of the stroke pattern of the object.

void	strokePatternTransform (double &scaleX, double &scaleY, double &offsetX, double &offsetY, double &rotation, double &skewX, double &skewY, double &space) const
	Get the stroke pattern transformation matrix of the object.

void	setStrokePattern (const QString &newPattern)
	Set the stroke pattern of the object. More...

void	setStrokePatternTransform (double scaleX, double scaleY, double offsetX, double offsetY, double rotation, double skewX, double skewY, double space)
	Set the stroke pattern transformation of the object.

void	setStrokePatternFlip (bool flipX, bool flipY)

void	strokePatternFlip (bool &flipX, bool &flipY)

void	setStrokePatternToPath (bool enable)

bool	isStrokePatternToPath ()

void	setLineQColor ()
	Set the QColor for the line.

void	setFillQColor ()
	Set the QColor for the fill.

Qt::PenStyle	lineStyle () const
	Get the style of line.

void	setLineStyle (Qt::PenStyle newStyle)
	Set the style of line. More...

double	lineWidth () const
	Get the width of the line.

void	setLineWidth (double newWidth)
	Set the width of line. More...

Qt::PenCapStyle	lineEnd () const
	Get the end cap style of the line.

void	setLineEnd (Qt::PenCapStyle newStyle)
	Set the end style of line. More...

Qt::PenJoinStyle	lineJoin () const
	Get the join style of multi-segment lines.

void	setLineJoin (Qt::PenJoinStyle newStyle)
	Set the join style of line. More...

QString	customLineStyle () const
	Get name of active custom line style.

void	setCustomLineStyle (const QString &newStyle)
	Set custom line style. More...

int	startArrowIndex () const
	Get start arrow index. More...

void	setStartArrowIndex (int newIndex)
	Set start arrow index. More...

int	endArrowIndex () const
	Get end arrow index. More...

void	setEndArrowIndex (int newIndex)
	Set end arrow index. More...

int	startArrowScale () const
	Get start arrow scale. More...

void	setStartArrowScale (int newScale)
	Set start arrow scale. More...

int	endArrowScale () const
	Get end arrow scale. More...

void	setEndArrowScale (int newScale)
	Set end arrow scale. More...

bool	imageFlippedH () const
	Is the image flipped horizontally?

void	setImageFlippedH (bool flipped)
	Horizontally flip / unflip the image.

void	flipImageH ()
	Flip an image horizontally.

bool	imageFlippedV () const
	Is the image flipped vertically?

void	setImageFlippedV (bool flipped)
	Vertically flip / unflip the image.

void	flipImageV ()
	Flip an image vertically.

void	setImageScalingMode (bool freeScale, bool keepRatio)
	Set the image scaling mode. More...

void	toggleLock ()
	Lock or unlock this pageitem.

bool	locked () const
	is the item locked ?

void	setLocked (bool isLocked)
	Lock or unlock this pageitem.

void	toggleSizeLock ()
	Toggle lock for resizing.

bool	sizeLocked () const
	Is the item's size locked?

bool	sizeHLocked () const

bool	sizeVLocked () const

void	setSizeLocked (bool isLocked)
	set lock for resizing

void	setSizeHLocked (bool isLocked)

void	setSizeVLocked (bool isLocked)

TextFlowMode	textFlowMode () const
	Does text flow around this object and how. More...

void	setTextFlowMode (TextFlowMode mode)
	Changes the way text flows around this item. More...

bool	textFlowAroundObject () const
	If text should flow around object frame. More...

bool	textFlowUsesFrameShape () const
	If text should flow around object frame. More...

bool	textFlowUsesBoundingBox () const
	If text should flow around bounding box. More...

bool	textFlowUsesContourLine () const
	If text should flow around contour line. More...

bool	textFlowUsesImageClipping () const
	If text should flow around image clipping path. More...

void	checkTextFlowInteractions (bool allItems=false)
	To be called carefully because it eventually triggers a relayout of long text frames strings, but necesarily when you change the document. More...

ItemType	itemType () const
	Get the frame type. More...

virtual ItemType	realItemType () const
	Get the subclass item type. More...

void	convertTo (ItemType newType)
	Convert this PageItem to PageItem type `newType` More...

virtual void	setLayer (int layerId)

void	checkChanges (bool force=false)
	Check the changes to the item and add undo actions for them. More...

void	restore (UndoState *state, bool isUndo)
	Required by the UndoObject.

virtual void	getNamedResources (ResourceCollection &lists) const

virtual void	replaceNamedResources (ResourceCollection &newNames)

QString	generateUniqueCopyName (const QString originalName, bool prependCopy=true) const
	Return a variant of `originalName' that is guaranteed to be unique in the same document as this PageItem. If the passed name is not in use it is returned unchanged. More...

bool	printEnabled () const
	Is this item printed? More...

void	setPrintEnabled (bool toPrint)
	Tells if the frame is set to be printed or not. More...

void	togglePrintEnabled ()
	Toggle printable. More...

bool	isTagged () const
	Tells if the frame is tagged or not. More...

void	setTagged (bool)
	Set the tagged member for use when deleting items, instead of reselecting them. More...

bool	loadImage (const QString &filename, const bool reload, const int gsResolution=-1, bool showMsg=false)
	Load an image into an image frame, moved from ScribusView. More...

bool	connectToGUI ()
	Connect the item's signals to the GUI, primarily the Properties palette, also some to ScMW. More...

bool	disconnectFromGUI ()

void	emitAllToGUI ()
	Emit the items properties to the GUI in one go.

ScribusDoc *	doc () const
	Get the document that this item belongs to.

bool	isAnnotation () const

void	setIsAnnotation (bool)

void	setIsBookMark (bool)

void	setAnnotation (const Annotation &ad)

Annotation &	annotation ()

const Annotation &	annotation () const

bool	imageVisible () const

void	setImageVisible (bool)

void	updateConstants ()

bool	isWelded ()

void	weldTo (PageItem *item)

QList< PageItem * >	itemsWeldedTo (PageItem *except=NULL)

void	unWeld ()

void	addWelded (PageItem *item)

void	moveWelded (double dX, double dY, int weld)

void	moveWelded (double dX, double dY, PageItem *except=NULL)

void	rotateWelded (double dR, double oldRot)

void	setWeldPoint (double dX, double dY, PageItem *pItem)
	added for autowelding feature of notes frames, setting welding point with given pItem to given coords

QString	getItemTextSaxed (int selStart, int selLength)
	used by notes frames to get content of notes from itemText

bool	groupClipping ()

void	setGroupClipping (bool val)

bool	hasFill ()

bool	hasStroke ()

int	maxCharsInFrame ()

Store undo actions
Add an undo action to the undo guis Author Riku Leino
void	moveUndoAction ()

void	resizeUndoAction ()

void	rotateUndoAction ()

void	changeImageOffsetUndoAction ()

void	changeImageScaleUndoAction ()

Public Member Functions inherited from UndoObject
	UndoObject ()
	Creates a new anonymous UndoObject instance.

	UndoObject (const UndoObject &other)
	Creates a copy of an UndoObject instance.

	UndoObject (const QString &objectName, QPixmap *objectIcon=0)
	Creates a new UndoObject instance with the name `objectName` More...

virtual	~UndoObject ()
	Destroys the object.

virtual QString	getUName ()
	Returns the name of the UndoObject. More...

virtual void	setUName (QString newUName)
	Set the name of the UndoObject. More...

virtual QPixmap *	getUPixmap ()
	Returns the pixmap connected to this object. More...

virtual void	setUPixmap (QPixmap *newUPixmap)
	Set the pixmap for this object. More...

ulong	getUId () const
	Returns an unique identifier number for the UndoObject. More...

const ScGuardedPtr< UndoObject > &	undoObjectPtr ()
	Returns a guarded pointer.

Public Member Functions inherited from SingleObservable< PageItem >
	SingleObservable (MassObservable< PageItem * > *massObservable)

void	setMassObservable (MassObservable< PageItem * > *massObservable)

virtual void	update ()

virtual void	updateLayout ()

Public Attributes
bool	AutoName

double	gXpos

double	gYpos

double	gWidth

double	gHeight

int	GrType
	used values 6 = linear, 7 = radial, 8 = pattern, 9 = 4 color gradient, 10 = diamond, 11,12,13 = mesh gradient, 14 = hatch

double	GrStartX

double	GrStartY

double	GrEndX

double	GrEndY

double	GrFocalX

double	GrFocalY

double	GrScale

double	GrSkew

VGradient::VGradientRepeatMethod	GrExtend

FPoint	GrControl1

FPoint	GrControl2

FPoint	GrControl3

FPoint	GrControl4

FPoint	GrControl5

QString	GrColorP1

QString	GrColorP2

QString	GrColorP3

QString	GrColorP4

double	GrCol1transp

double	GrCol2transp

double	GrCol3transp

double	GrCol4transp

int	GrCol1Shade

int	GrCol2Shade

int	GrCol3Shade

int	GrCol4Shade

QList< meshGradientPatch >	meshGradientPatches

QList< QList< meshPoint > >	meshGradientArray

int	selectedMeshPointX

int	selectedMeshPointY

int	selectedMeshControlPoint

bool	snapToPatchGrid

double	gridOffset_

double	gridValue_

int	m_startArrowIndex

int	m_endArrowIndex

int	m_startArrowScale

int	m_endArrowScale

Qt::PenStyle	PLineArt
	Linestyle.

Qt::PenCapStyle	PLineEnd

Qt::PenJoinStyle	PLineJoin

QString	NamedLStyle

QPolygon	Clip
	Defines clipping region of the elements.

FPointArray	PoLine

FPointArray	ContourLine

FPointArray	imageClip

QList< uint >	Segments

ScImageEffectList	effectsInUse

bool	PoShow

double	BaseOffs

int	textPathType

bool	textPathFlipped

bool	ClipEdited

int	FrameType
	Don't know exactly what this is, but it's not the same as itemType.

uint	uniqueNr
	Internal unique Item-Number, used for the undo system.

int	OwnPage
	page this element belongs to

int	oldOwnPage
	Old page number tracked for the move undo action.

int	savedOwnPage

ScImage	pixm
	Darzustellendes Bild.

QString	Pfile
	Dateiname des Bildes.

QString	Pfile2

QString	Pfile3

QString	IProfile

bool	UseEmbedded

QString	EmProfile

eRenderIntent	IRender

bool	OverrideCompressionMethod

int	CompressionMethodIndex

bool	OverrideCompressionQuality

int	CompressionQualityIndex

bool	imageIsAvailable
	Flag to hiold image file availability.

int	OrigW

int	OrigH

double	BBoxX
	Bounding Box-X.

double	BBoxH
	Bounding Box-H.

double	CurX
	Zeichen X-Position.

double	CurY
	Zeichen Y-Position.

StoryText	itemText
	Text of element.

TextLayout	textLayout

bool	isBookmark
	Flag for PDF Bookmark.

bool	Dirty
	Flag for redraw in EditMode.

bool	invalid
	Flag indicates that layout has changed (eg. for textlayout)

bool	HasSel
	Flag for text selection.

bool	FrameOnly
	avoid artefacts while moving

bool	isAutoText

PageItem *	Parent

bool	inPdfArticle

bool	isRaster

double	OldB

double	OldH

double	OldB2

double	OldH2

bool	Sizing

int	LayerID

bool	ScaleType

bool	AspectRatio

QVector< double >	DashValues

double	DashOffset

VGradient	fill_gradient

bool	fillRule

bool	doOverprint

bool	m_hasSoftShadow

QString	m_softShadowColor

int	m_softShadowShade

double	m_softShadowBlurRadius

double	m_softShadowXOffset

double	m_softShadowYOffset

double	m_softShadowOpacity

int	m_softShadowBlendMode

bool	m_softShadowErasedByObject

bool	m_softShadowHasObjectTransparency

PageItem *	LeftLink

PageItem *	RightLink

PageItem *	TopLink

PageItem *	BottomLink

int	LeftLinkID

int	RightLinkID

int	TopLinkID

int	BottomLinkID

bool	LeftLine

bool	RightLine

bool	TopLine

bool	BottomLine

bool	isTableItem

bool	isSingleSel

QList< PageItem * >	groupItemList

double	groupWidth

double	groupHeight

double	BoundingX

double	BoundingY

double	BoundingW

double	BoundingH

bool	ChangedMasterItem

QString	OnMasterPage

bool	isEmbedded

int	inlineCharID

QString	inlineExt

double	oldXpos
	Stores the old X-position for undo action. Is used to detect move actions.

double	oldYpos
	Stores the old Y-position for undo action. Is used to detect move actions.

double	oldWidth
	Stores the old width for undo action. Is used to detect resize actions.

double	oldHeight
	Stores the old height for undo action. Is used to detect resize actions.

double	oldRot
	Stores the old rotation value for undo action. Is used to detect rotation actions.

double	oldLocalScX
	Stores the old LocalScX value for undo action. Is used to detect image scale actions.

double	oldLocalScY
	Stores the old LocalScY value for undo action. Is used to detect image scale actions.

double	oldLocalX
	Stores the old LocalX value for undo action. Is used to detect image offset actions.lo j.

double	oldLocalY
	Stores the old LocalY value for undo action. Is used to detect image offset actions.

ScribusDoc *	m_Doc
	Document this item belongs to.

bool	m_isAnnotation
	Flag to tell if this item is a PDF annotation item.

Annotation	m_annotation
	PDF annotation data.

bool	m_imageVisible
	Darstellungsart Bild/Titel.

double	m_lineWidth

double	Oldm_lineWidth

QString	patternStrokeVal
	Stroke pattern name. More...

double	patternStrokeScaleX
	Stroke pattern transformation matrix.

double	patternStrokeScaleY

double	patternStrokeOffsetX

double	patternStrokeOffsetY

double	patternStrokeRotation

double	patternStrokeSkewX

double	patternStrokeSkewY

double	patternStrokeSpace

bool	patternStrokeMirrorX

bool	patternStrokeMirrorY

bool	patternStrokePath

QString	gradientStrokeVal
	Stroke gradient name. More...

VGradient	stroke_gradient

int	GrTypeStroke
	Stroke gradient variables.

double	GrStrokeStartX

double	GrStrokeStartY

double	GrStrokeEndX

double	GrStrokeEndY

double	GrStrokeFocalX

double	GrStrokeFocalY

double	GrStrokeScale

double	GrStrokeSkew

VGradient::VGradientRepeatMethod	GrStrokeExtend

int	GrMask
	Mask gradient variables.

double	GrMaskStartX

double	GrMaskStartY

double	GrMaskEndX

double	GrMaskEndY

double	GrMaskFocalX

double	GrMaskFocalY

double	GrMaskScale

double	GrMaskSkew

double	patternMaskScaleX

double	patternMaskScaleY

double	patternMaskOffsetX

double	patternMaskOffsetY

double	patternMaskRotation

double	patternMaskSkewX

double	patternMaskSkewY

bool	patternMaskMirrorX

bool	patternMaskMirrorY

QString	patternMaskVal

QString	gradientMaskVal

VGradient	mask_gradient

bool	isInlineImage

bool	isTempFile

QList< WeldingInfo >	weldList

double	hatchAngle

double	hatchDistance

int	hatchType

bool	hatchUseBackground

QString	hatchBackground

QString	hatchForeground

Protected Member Functions
	PageItem (const PageItem &other)

void	DrawObj_ImageFrame (ScPainter *p, double sc)

void	DrawObj_Polygon (ScPainter *p)

void	DrawObj_PolyLine (ScPainter *p)

void	DrawObj_PathText (ScPainter *p, double sc)

void	drawLockedMarker (ScPainter *p)

void	drawArrow (ScPainter *p, QTransform &arrowTrans, int arrowIndex)

bool	checkGradientUndoRedo (SimpleState *state, bool isUndo)

bool	shouldCheck ()
	Returns true if the actions should be sent to the UndoManager. More...

void	select ()
	Clears the current selection and selects this PageItem.

Restore helper methods
Split the restore method for easier handling. Author Riku Leino
void	restoreAppMode (SimpleState *state, bool isUndo)

void	restoreArc (SimpleState *state, bool isUndo)

void	restoreArrow (SimpleState *state, bool isUndo, bool isStart)

void	restoreBottomTextFrameDist (SimpleState *state, bool isUndo)

void	restoreCharStyle (SimpleState *state, bool isUndo)

void	restoreClearImage (UndoState *state, bool isUndo)

void	restoreColumns (SimpleState *state, bool isUndo)

void	restoreColumnsGap (SimpleState *state, bool isUndo)

void	restoreConnectPath (SimpleState *state, bool isUndo)

void	restoreContourLine (SimpleState *state, bool isUndo)

void	restoreCornerRadius (SimpleState *state, bool isUndo)

void	restoreCreateMeshGrad (SimpleState *state, bool isUndo)

void	restoreCustomLineStyle (SimpleState *state, bool isUndo)

void	restoreDefaultParagraphStyle (SimpleState *state, bool isUndo)

void	restoreDeleteFrameText (SimpleState *state, bool isUndo)

void	restoreDropLinks (UndoState *state, bool isUndo)

void	restoreEndArrowScale (SimpleState *state, bool isUndo)

void	restoreFill (SimpleState *state, bool isUndo)

void	restoreFillGradient (SimpleState *state, bool isUndo)

void	restoreFillTP (SimpleState *state, bool isUndo)

void	restoreFirstLineOffset (SimpleState *state, bool isUndo)

void	restoreGetImage (UndoState *state, bool isUndo)

void	restoreGradPos (SimpleState *state, bool isUndo)

void	restoreGradientCol1 (SimpleState *state, bool isUndo)

void	restoreGradientCol2 (SimpleState *state, bool isUndo)

void	restoreGradientCol3 (SimpleState *state, bool isUndo)

void	restoreGradientCol4 (SimpleState *state, bool isUndo)

void	restoreGradientColor1 (SimpleState *state, bool isUndo)

void	restoreGradientColor2 (SimpleState *state, bool isUndo)

void	restoreGradientColor3 (SimpleState *state, bool isUndo)

void	restoreGradientColor4 (SimpleState *state, bool isUndo)

void	restoreGradientControl1 (SimpleState *state, bool isUndo)

void	restoreGradientControl2 (SimpleState *state, bool isUndo)

void	restoreGradientControl3 (SimpleState *state, bool isUndo)

void	restoreGradientControl4 (SimpleState *state, bool isUndo)

void	restoreGradientControl5 (SimpleState *state, bool isUndo)

void	restoreGradientEndX (SimpleState *state, bool isUndo)

void	restoreGradientEndY (SimpleState *state, bool isUndo)

void	restoreGradientFocalX (SimpleState *state, bool isUndo)

void	restoreGradientFocalY (SimpleState *state, bool isUndo)

void	restoreGradientMaskEndX (SimpleState *state, bool isUndo)

void	restoreGradientMaskEndY (SimpleState *state, bool isUndo)

void	restoreGradientMaskFocalX (SimpleState *state, bool isUndo)

void	restoreGradientMaskFocalY (SimpleState *state, bool isUndo)

void	restoreGradientMaskScale (SimpleState *state, bool isUndo)

void	restoreGradientMaskSkew (SimpleState *state, bool isUndo)

void	restoreGradientMaskStartX (SimpleState *state, bool isUndo)

void	restoreGradientMaskStartY (SimpleState *state, bool isUndo)

void	restoreGradientMeshColor (SimpleState *state, bool isUndo)

void	restoreGradientScale (SimpleState *state, bool isUndo)

void	restoreGradientShade1 (SimpleState *state, bool isUndo)

void	restoreGradientShade2 (SimpleState *state, bool isUndo)

void	restoreGradientShade3 (SimpleState *state, bool isUndo)

void	restoreGradientShade4 (SimpleState *state, bool isUndo)

void	restoreGradientSkew (SimpleState *state, bool isUndo)

void	restoreGradientStartX (SimpleState *state, bool isUndo)

void	restoreGradientStartY (SimpleState *state, bool isUndo)

void	restoreGradientStrokeEndX (SimpleState *state, bool isUndo)

void	restoreGradientStrokeEndY (SimpleState *state, bool isUndo)

void	restoreGradientStrokeFocalX (SimpleState *state, bool isUndo)

void	restoreGradientStrokeFocalY (SimpleState *state, bool isUndo)

void	restoreGradientStrokeScale (SimpleState *state, bool isUndo)

void	restoreGradientStrokeSkew (SimpleState *state, bool isUndo)

void	restoreGradientStrokeStartX (SimpleState *state, bool isUndo)

void	restoreGradientStrokeStartY (SimpleState *state, bool isUndo)

void	restoreGradientTrans1 (SimpleState *state, bool isUndo)

void	restoreGradientTrans2 (SimpleState *state, bool isUndo)

void	restoreGradientTrans3 (SimpleState *state, bool isUndo)

void	restoreGradientTrans4 (SimpleState *state, bool isUndo)

void	restoreGradientType (SimpleState *state, bool isUndo)

void	restoreGradientTypeStroke (SimpleState *state, bool isUndo)

void	restoreImageEffects (UndoState *state, bool isUndo)

void	restoreImageNbr (SimpleState *state, bool isUndo)

void	restoreImageOffsetChange (SimpleState *state, bool isUndo)

void	restoreImageRotation (SimpleState *state, bool isUndo)

void	restoreImageScaleChange (SimpleState *state, bool isUndo)

void	restoreImageScaleMode (SimpleState *state, bool isUndo)

void	restoreInsertFrameText (SimpleState *state, bool isUndo)

void	restoreLayer (SimpleState *state, bool isUndo)

void	restoreLeftTextFrameDist (SimpleState *state, bool isUndo)

void	restoreLineColor (SimpleState *state, bool isUndo)

void	restoreLineEnd (SimpleState *state, bool isUndo)

void	restoreLineJoin (SimpleState *state, bool isUndo)

void	restoreLineShade (SimpleState *state, bool isUndo)

void	restoreLineStyle (SimpleState *state, bool isUndo)

void	restoreLineTP (SimpleState *state, bool isUndo)

void	restoreLineWidth (SimpleState *state, bool isUndo)

void	restoreLinkTextFrame (UndoState *state, bool isUndo)

void	restoreMarkString (SimpleState *state, bool isUndo)

void	restoreMaskGradient (SimpleState *state, bool isUndo)

void	restoreMaskType (SimpleState *state, bool isUndo)

void	restoreMove (SimpleState *state, bool isUndo)

void	restoreMoveMeshGrad (SimpleState *state, bool isUndo)

void	restoreMoveMeshPatch (SimpleState *state, bool isUndo)

void	restoreName (SimpleState *state, bool isUndo)

void	restorePStyle (SimpleState *state, bool isUndo)

void	restoreParagraphStyle (SimpleState *state, bool isUndo)

void	restorePasteInline (SimpleState *state, bool isUndo)

void	restorePasteText (SimpleState *state, bool isUndo)

void	restorePathOperation (UndoState *state, bool isUndo)

void	restorePoly (SimpleState *state, bool isUndo, bool isContour)

void	restorePolygon (SimpleState *state, bool isUndo)

void	restoreRemoveMeshPatch (SimpleState *state, bool isUndo)

void	restoreResTyp (SimpleState *state, bool isUndo)

void	restoreResetMeshGrad (SimpleState *state, bool isUndo)

void	restoreResize (SimpleState *state, bool isUndo)

void	restoreReverseText (UndoState *state, bool isUndo)

void	restoreRightTextFrameDist (SimpleState *state, bool isUndo)

void	restoreRotate (SimpleState *state, bool isUndo)

void	restoreSetCharStyle (SimpleState *state, bool isUndo)

void	restoreSetParagraphStyle (SimpleState *state, bool isUndo)

void	restoreShade (SimpleState *state, bool isUndo)

void	restoreShapeContour (UndoState *state, bool isUndo)

void	restoreShapeType (SimpleState *state, bool isUndo)

void	restoreShowImage (SimpleState *state, bool isUndo)

void	restoreSnapToPatchGrid (SimpleState *state, bool isUndo)

void	restoreSpiral (SimpleState *state, bool isUndo)

void	restoreSplitItem (SimpleState *state, bool isUndo)

void	restoreStartArrowScale (SimpleState *state, bool isUndo)

void	restoreStrokeGradient (SimpleState *state, bool isUndo)

void	restoreTextFlowing (SimpleState *state, bool isUndo)

void	restoreTopTextFrameDist (SimpleState *state, bool isUndo)

void	restoreTransform (SimpleState *state, bool isUndo)

void	restoreType (SimpleState *state, bool isUndo)

void	restoreUnWeldItem (SimpleState *state, bool isUndo)

void	restoreUniteItem (SimpleState *state, bool isUndo)

void	restoreUnlinkTextFrame (UndoState *state, bool isUndo)

void	restoreVerticalAlign (SimpleState *state, bool isUndo)

void	restoreWeldItems (SimpleState *state, bool isUndo)

void	restoreSoftShadow (SimpleState *state, bool isUndo)

void	restoreSoftShadowColor (SimpleState *state, bool isUndo)

void	restoreSoftShadowShade (SimpleState *state, bool isUndo)

void	restoreSoftShadowBlurRadius (SimpleState *state, bool isUndo)

void	restoreSoftShadowXOffset (SimpleState *state, bool isUndo)

void	restoreSoftShadowYOffset (SimpleState *state, bool isUndo)

void	restoreSoftShadowOpacity (SimpleState *state, bool isUndo)

void	restoreSoftShadowBlendMode (SimpleState *state, bool isUndo)

void	restoreSoftShadowErasedByObject (SimpleState *state, bool isUndo)

void	restoreSoftShadowHasObjectTransparency (SimpleState *state, bool isUndo)

Protected Attributes
UndoManager *const	undoManager
	Manages undostack and is where all undo actions/states are sent.

PageItem *	BackBox

PageItem *	NextBox

uint	firstChar

uint	MaxChars

bool	m_sampleItem
	Used to not draw the frame for sample items.

MarginStruct	m_textDistanceMargins
	Left, Top, Bottom, Right distances of text from the frame.

int	verticalAlign

ItemType	m_ItemType
	Frame Type, eg line, text frame, etc. More...

QString	AnName
	Item name. Unicode. User visible (outline, property palette, etc). More...

QString	gradientVal
	Fill gradient name. More...

QString	patternVal
	Fill pattern name. More...

double	patternScaleX
	Fill pattern transformation matrix.

double	patternScaleY

double	patternOffsetX

double	patternOffsetY

double	patternRotation

double	patternSkewX

double	patternSkewY

bool	patternMirrorX

bool	patternMirrorY

QString	fillColorVal
	Fill color name. More...

QString	lineColorVal
	Line color name. More...

double	lineShadeVal
	Line shade. More...

double	fillShadeVal
	Fill shade. More...

double	fillTransparencyVal
	Fill transparency. More...

double	lineTransparencyVal
	Line stroke transparency. More...

int	fillBlendmodeVal
	Fill transparency blendmode. More...

int	lineBlendmodeVal
	Line stroke transparency blendmode. More...

TextFlowMode	textFlowModeVal
	Should text flow around the item. More...

ObjAttrVector	pageItemAttributes
	Stores the attributes of the pageitem (NOT properties, the user defined ATTRIBUTES) More...

bool	tagged
	Is this item set to have an action done to it, eg deleted. More...

bool	no_fill

bool	no_stroke

QColor	fillQColor

QColor	strokeQColor

QColor	GrColorP1QColor

QColor	GrColorP2QColor

QColor	GrColorP3QColor

QColor	GrColorP4QColor

double	m_xPos
	X position on the page.

double	m_yPos
	Y position on the page.

double	m_width
	Width of the item.

double	m_height
	Height of the item.

bool	m_isSelected
	Is the item selected?

double	m_imageXOffset
	Image X Offset to frame.

double	m_imageYOffset
	Image Y Offset to frame.

double	m_imageRotation
	Image rotation in frame.

FirstLineOffsetPolicy	firstLineOffsetP

bool	m_groupClips

QColor	hatchBackgroundQ

QColor	hatchForegroundQ

Properties
QString	itemName

QString	fillColor

QString	lineColor

double	fillShade

double	lineShade

double	fillTransparency

double	lineTransparency

bool	m_Locked
	Is the item locked (cannot be moved, resized, etc)? More...

bool	m_SizeLocked
	Is the item's size locked? More...

bool	m_SizeHLocked

bool	m_SizeVLocked

bool	m_ImageIsFlippedV
	Is the image in this image item flipped vertically? More...

bool	m_ImageIsFlippedH
	Is the image in this image item flipped horizontally? More...

double	lineWidth

QString	customLineStyle

int	startArrowIndex

int	endArrowIndex

bool	m_PrintEnabled
	Is this item set to be printed/exported. More...

double	xPos

double	yPos

double	width

double	height

double	m_rotation
	Rotation of the item.

double	m_imageXScale
	Scaling X Factor for images.

double	m_imageYScale
	Scaling Y Factor for images.

double	imageXOffset

double	imageYOffset

bool	m_isReversed
	Is the frame is reversed?

double	m_roundedCorderRadius

double	textToFrameDistLeft

double	textToFrameDistRight

double	textToFrameDistTop

double	textToFrameDistBottom

double	ColGap

int	Cols

FirstLineOffsetPolicy	firstLineOffset

ItemType	itemType
	Item type. More...

Additional Inherited Members
Static Public Member Functions inherited from SaxIO
static void	desaxeRules (const Xml_string &, desaxe::Digester &, const Xml_string=saxxDefaultElem)

Static Public Attributes inherited from SaxIO
static const Xml_string	saxxDefaultElem

Detailed Description

Author: Franz Schmid

Member Enumeration Documentation

enum PageItem::DrawOption

Draw options for DrawObj_toImage()

enum PageItem::ItemType

Item Type.

Soon, item type will probably go away in favour of using subclasses and checking types using more conventional methods and using Qt's MetaObject introspection. Multiple is used for checking in

See also: Selection for all same type of items

enum PageItem::TextFlowMode

Text flow mode.

Describe if and how text flow around object

Member Function Documentation

ParagraphStyle & PageItem::changeCurrentStyle ( )

returns the style at the current charpos for changing

returns the style at the current charpos

void PageItem::checkChanges ( bool force = false )

Check the changes to the item and add undo actions for them.

Parameters

force Force the check. Do not care if mouse button or arrow key is down check anyway.

Author: Riku Leino

bool PageItem::checkGradientUndoRedo	(	SimpleState *	state,
		bool	isUndo
	)

protected

Split the restore methods

void PageItem::checkTextFlowInteractions ( bool allItems = false )

To be called carefully because it eventually triggers a relayout of long text frames strings, but necesarily when you change the document.

Parameters

allItems While you generally want to check for items below, it can happen that you want to update full range of text frames (e.g. when shuffle items order). Default to false.

bool PageItem::connectToGUI ( )

Connect the item's signals to the GUI, primarily the Properties palette, also some to ScMW.

Returns

void PageItem::convertTo ( ItemType newType )

Convert this PageItem to PageItem type newType

Parameters

newType PageItem type for conversion

void PageItem::DrawObj	(	ScPainter *	p,
		QRectF	cullingArea
	)

Paints the item. CHANGE: cullingArea is in doc coordinates!

int PageItem::endArrowIndex ( ) const

inline

Get end arrow index.

See also: PageItem::startArrowIndex(), PageItem::setEndArrowIndex()

int PageItem::endArrowScale ( ) const

inline

Get end arrow scale.

See also: PageItem::startArrowIndex(), PageItem::setEndArrowIndex()

bool PageItem::frameDisplays ( int textpos ) const

tests if a character is displayed by this fram

tests if a character is displayed by this frame

QString PageItem::generateUniqueCopyName	(	const QString	originalName,
		bool	prependCopy = `true`
	)		const

Return a variant of `originalName' that is guaranteed to be unique in the same document as this PageItem. If the passed name is not in use it is returned unchanged.

Author: Craig Ringer

Usually of the form 'Copy of [name]' or 'Copy of [name] (n)' cezaryece: if prependCopy is false then form '[name] (n)' is generated

ObjectAttribute PageItem::getObjectAttribute ( QString attributeName ) const

brief Returns a complete ObjectAttribute struct if 1 is found, or ObjectAttribute.name will be QString::null if 0 or >1 are found

QList< ObjectAttribute > PageItem::getObjectAttributes ( QString attributeName ) const

brief Returns a list of attributes with specified name

bool PageItem::isTagged ( ) const

inline

Tells if the frame is tagged or not.

See also: isTagged()

QString PageItem::itemName ( ) const

inline

Get name of the item.

This is unrelated to QObject::name(); the pageItem's name is independent of its Qt name. See also PageItem::setItemName()

ItemType PageItem::itemType ( ) const

inline

Get the frame type.

Attention: The whole concept of frame types is due for some radical re-working, so don't rely on this interface staying stable. It's here as an interim step to eliminate direct member access on PageItems.

double PageItem::layoutGlyphs	(	const CharStyle &	style,
		const QString &	chars,
		LayoutFlags	flags,
		GlyphLayout &	layout
	)

layout glyphs translates the chars into a number of glyphs, applying the Charstyle 'style'. The following fields are set in layout: glyph, more, scaleH, scaleV, xoffset, yoffset, xadvance. If the DropCap-bit in style.effects is set and yadvance is > 0, scaleH/V, x/yoffset and xadvance are modified to scale the glyphs to this height. Otherwise yadvance is set to the max ascender of all generated glyphs. It scales according to smallcaps and sets xadvance to the advance width without kerning. If more than one glyph is generated, kerning is included in all but the last xadvance.

bool PageItem::loadImage	(	const QString &	filename,
		const bool	reload,
		const int	gsResolution = `-1`,
		bool	showMsg = `false`
	)

Load an image into an image frame, moved from ScribusView.

Returns: True if load succeeded

bool PageItem::mouseWithinItem	(	const int	x,
		const int	y,
		double	scale
	)		const

Check if the mouse is within the items boundaries This method performs necessary page to device transformations.

Parameters

x	X position
y	Y position
scale	scale of the vport

Returns: bool true if the x, y is in the bounds

void PageItem::moveImageInFrame	(	double	newX,
		double	newY
	)

Move the image within the frame Old ScribusView::MoveItemI.

Todo:: Move to PageItem_ImageFrame

bool PageItem::pointWithinItem	(	const int	x,
		const int	y
	)		const

Check if a QPoint is within the items boundaries No coordinates transformation is performed.

Parameters

x	X position
y	Y position

Returns: bool true if x, i in the item

bool PageItem::printEnabled ( ) const

inline

Is this item printed?

See also: setPrintEnabled()

virtual ItemType PageItem::realItemType ( ) const

inlinevirtual

Get the subclass item type.

This function should be used everywhere, where a itemType is required, but no C++ type informations is available. e.g. when saving files, etc. It returns the same type as itemType() for the standard classes, but subclasses override it.

Reimplemented in PageItem_Table, PageItem_OSGFrame, PageItem_LatexFrame, PageItem_Arc, PageItem_Group, PageItem_RegularPolygon, PageItem_Spiral, and PageItem_Symbol.

void PageItem::saxx	(	SaxHandler &	,
		const Xml_string &
	)		const

inlinevirtual

Writes an XML representation of this object

Implements SaxIO.

void PageItem::saxx ( SaxHandler & ) const

inlinevirtual

Writes an XML representation of this object using the default element tag, see below

Implements SaxIO.

void PageItem::setCustomLineStyle ( const QString & newStyle )

Set custom line style.

Parameters

newStyle name of the custom style

void PageItem::setEndArrowIndex ( int newIndex )

Set end arrow index.

Parameters

newIndex index for end arrow

void PageItem::setEndArrowScale ( int newScale )

Set end arrow scale.

Parameters

newIndex scale for end arrow

void PageItem::setFillBlendmode ( int newBlendmode )

Set the blendmode of the fill color.

Parameters

newBlendmode blendmode of the fill color

void PageItem::setFillColor ( const QString & newColor )

Set the fill color of the object.

Parameters

newColor fill color for the object

void PageItem::setFillShade ( double newShade )

Set the fill color shade.

Parameters

newShade shade for the fill color

void PageItem::setFillTransparency ( double newTransparency )

Set the transparency of the fill color.

Parameters

newTransparency transparency of the fill color

void PageItem::setGradient ( const QString & newGradient )

Set the fill gradient of the object.

Parameters

newGradient fill gradient for the object

void PageItem::setImageScalingMode	(	bool	freeScale,
		bool	keepRatio
	)

Set the image scaling mode.

Parameters

freeScale	is the scaling free (not forced to frame size)
keepRatio	should the image's aspect ratio be respected

void PageItem::setItemName ( const QString & newName )

Set name of the item.

Parameters

newName name for the item

Author: Riku Leino

Note that this is unrelated to QObject::setName() See also PageItem::itemName()

void PageItem::setLayer ( int layerId )

virtual

Set the layer for the item

Parameters

layerId layer where this item is moved

Reimplemented in PageItem_Group.

void PageItem::setLineBlendmode ( int newBlendmode )

Set the blendmode of the stroke color.

Parameters

newBlendmode blendmode of the stroke color

void PageItem::setLineColor ( const QString & newColor )

Set the line color of the object.

Parameters

newColor line color for the object

void PageItem::setLineEnd ( Qt::PenCapStyle newStyle )

Set the end style of line.

Parameters

newStyle end style of line

See also: Qt::PenCapStyle

void PageItem::setLineJoin ( Qt::PenJoinStyle newStyle )

Set the join style of line.

Parameters

newStyle join style of line

See also: Qt::PenJoinStyle

void PageItem::setLineShade ( double newShade )

Set the line color shade.

Parameters

newShade shade for the line color

void PageItem::setLineStyle ( Qt::PenStyle newStyle )

Set the style of line.

Parameters

newStyle style of line

See also: Qt::PenStyle

void PageItem::setLineTransparency ( double newTransparency )

Set the transparency of the line color.

Parameters

newTransparency transparency of the line color

void PageItem::setLineWidth ( double newWidth )

Set the width of line.

Parameters

newWidth width of line

void PageItem::setPattern ( const QString & newPattern )

Set the fill pattern of the object.

Parameters

newPattern fill pattern for the object

void PageItem::setPrintEnabled ( bool toPrint )

Tells if the frame is set to be printed or not.

See also: printable()

void PageItem::setStartArrowIndex ( int newIndex )

Set start arrow index.

Parameters

newIndex index for start arrow

void PageItem::setStartArrowScale ( int newScale )

Set start arrow scale.

Parameters

newIndex scale for start arrow

void PageItem::setStrokeGradient ( const QString & newGradient )

Set the stroke gradient of the object.

Parameters

newGradient stroke gradient for the object

void PageItem::setStrokePattern ( const QString & newPattern )

Set the stroke pattern of the object.

Parameters

newPattern stroke pattern for the object

void PageItem::setTagged ( bool tag )

Set the tagged member for use when deleting items, instead of reselecting them.

See also: setTagged()

void PageItem::setTextFlowMode ( TextFlowMode mode )

Changes the way text flows around this item.

Parameters

mode	true if text is wanted to flow around this object or false if not

See also: textFlowMode()

void PageItem::setTextToFrameDist	(	double	newLeft,
		double	newRight,
		double	newTop,
		double	newBottom
	)

Set the text to frame distances all at once.

Parameters

newLeft	left distance
newRight	right distance
newTop	top distance
newBottom	bottom distance

bool PageItem::shouldCheck ( )

protected

Returns true if the actions should be sent to the UndoManager.

Checks the state of the arrow keys and mouse buttons. If a key or a mouse button is down PageItem is under some action which should only be stored after the action has been finished (to get a single undo action).

Returns: true if the actions should be sent to the UndoManager based on the state of arrow keys and mouse buttons else returns false.

int PageItem::startArrowIndex ( ) const

inline

Get start arrow index.

See also: PageItem::endArrowIndex(), PageItem::setStartArrowIndex()

int PageItem::startArrowScale ( ) const

inline

Get start arrow scale.

See also: PageItem::endArrowIndex(), PageItem::setStartArrowIndex()

bool PageItem::textFlowAroundObject ( ) const

inline

If text should flow around object frame.

See also: PageItem::setTextFlowMode()

TextFlowMode PageItem::textFlowMode ( ) const

inline

Does text flow around this object and how.

See also: setTextFlowMode()

bool PageItem::textFlowUsesBoundingBox ( ) const

inline

If text should flow around bounding box.

See also: PageItem::setTextFlowMode()

bool PageItem::textFlowUsesContourLine ( ) const

inline

If text should flow around contour line.

See also: PageItem::setTextFlowMode()

bool PageItem::textFlowUsesFrameShape ( ) const

inline

If text should flow around object frame.

See also: PageItem::setTextFlowMode()

bool PageItem::textFlowUsesImageClipping ( ) const

inline

If text should flow around image clipping path.

See also: PageItem::setTextFlowMode()

void PageItem::togglePrintEnabled ( )

Toggle printable.

See also: setPrintable()

Member Data Documentation

QString PageItem::AnName

protected

Item name. Unicode. User visible (outline, property palette, etc).

Todo:

This is Annotation Name.. not item name, needs splitting up.

See also: PageItem::itemName(), PageItem::setItemName()

int PageItem::fillBlendmodeVal

protected

Fill transparency blendmode.

See also: PageItem::fillBlendmode(), PageItem::setFillBlendmode()

QString PageItem::fillColorVal

protected

Fill color name.

See also: PageItem::fillColor(), PageItem::setFillColor()

double PageItem::fillShadeVal

protected

Fill shade.

See also: PageItem::fillShade, PageItem::setFillShade()

double PageItem::fillTransparencyVal

protected

Fill transparency.

See also: PageItem::fillTransparency(), PageItem::setFillTransparency()

QString PageItem::gradientStrokeVal

Stroke gradient name.

See also: PageItem::strokeGradient(), PageItem::setStrokeGradient()

QString PageItem::gradientVal

protected

Fill gradient name.

See also: PageItem::gradient(), PageItem::setGradient()

bool PageItem::isInlineImage

Inline Image

int PageItem::lineBlendmodeVal

protected

Line stroke transparency blendmode.

See also: PageItem::lineBlendmode(), PageItem::setLineBlendmode()

QString PageItem::lineColorVal

protected

Line color name.

See also: PageItem::lineColor(), PageItem::setLineColor()

double PageItem::lineShadeVal

protected

Line shade.

See also: PageItem::lineShade, PageItem::setLineShade()

double PageItem::lineTransparencyVal

protected

Line stroke transparency.

See also: PageItem::lineTransparency(), PageItem::setLineTransparency()

ItemType PageItem::m_ItemType

protected

Frame Type, eg line, text frame, etc.

This will probably go away when pageitem is split into subclasses.

ObjAttrVector PageItem::pageItemAttributes

protected

Stores the attributes of the pageitem (NOT properties, the user defined ATTRIBUTES)

See also

QString PageItem::patternStrokeVal

Stroke pattern name.

See also: PageItem::strokePattern(), PageItem::setStrokePattern()

QString PageItem::patternVal

protected

Fill pattern name.

See also: PageItem::pattern(), PageItem::setPattern()

bool PageItem::tagged

protected

Is this item set to have an action done to it, eg deleted.

See also: PageItem::isTagged(), PageItem::setTagged()

TextFlowMode PageItem::textFlowModeVal

protected

Should text flow around the item.

See also: PageItem::textFlowMode(), PateItem::setTextFlowMode()

Property Documentation

ItemType PageItem::itemType

readwrite

Item type.

Warning: Do not set this property except for testing and debug purposes.

bool PageItem::m_ImageIsFlippedH

readwrite

Is the image in this image item flipped horizontally?

See also: PageItem::isImageFlippedH(), PageItem::setImageFlippedH(), PageItem::flipImageH(), PageItem::flippedV

bool PageItem::m_ImageIsFlippedV

readwrite

Is the image in this image item flipped vertically?

See also: PageItem::isImageFlippedV(), PageItem::setImageFlippedV(), PageItem::flipImageV(), PageItem::flippedH

bool PageItem::m_Locked

readwrite

Is the item locked (cannot be moved, resized, etc)?

See also: PageItem::locked(), PageItem::setLocked(), PageItem::toggleLock()

bool PageItem::m_PrintEnabled

readwrite

Is this item set to be printed/exported.

See also: PageItem::printable(), PageItem::setPrintable()

double PageItem::m_roundedCorderRadius

readwrite

Radius of rounded corners

bool PageItem::m_SizeHLocked

readwrite

notes frames - locking horizontal or vertical size

bool PageItem::m_SizeLocked

readwrite

Is the item's size locked?

See also: PageItem::sizeLocked(), PageItem::setSizeLocked(), PageItem::toggleSizeLock()

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

/Users/ale/src/Scribus/scribus/pageitem.h
/Users/ale/src/Scribus/scribus/pageitem.cpp

Classes

Public Types

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation