fg_FillType Class Reference

#include <fp_ContainerObject.h>

List of all members.

Public Member Functions

fg_FillType (fg_FillType *pParent, fp_ContainerObject *pContainer, FG_Fill_Type iType)

virtual ~fg_FillType (void)

void setParent (fg_FillType *pParent)

void setColor (UT_RGBColor &color)

void setColor (const char *pszColor)

void setTransColor (UT_RGBColor &color)

void setTransColor (const char *pszColor)

void setImage (FG_Graphic *pGraphic, GR_Image *pImage, GR_Graphics *pG, UT_sint32 width, UT_sint32 height)

void setTransparent (void)

void setWidthHeight (GR_Graphics *pG, UT_sint32 width, UT_sint32 height, bool doImage=false)

void setWidth (GR_Graphics *pG, UT_sint32 width)

void setHeight (GR_Graphics *pG, UT_sint32 height)

void setDocLayout (FL_DocLayout *pDocLayout)

void markTransparentForPrint (void)

void Fill (GR_Graphics *pG, UT_sint32 &srcX, UT_sint32 &srcY, UT_sint32 x, UT_sint32 y, UT_sint32 width, UT_sint32 height)

fg_FillType * getParent (void) const

FG_Fill_Type getFillType (void) const

FL_DocLayout * getDocLayout (void)

UT_RGBColor * getColor (void)

void setImagePointer (FG_Graphic **pDocGraphic, GR_Image **pDocImage)

Private Member Functions

void _regenerateImage (GR_Graphics *pG)

Private Attributes

fg_FillType * m_pParent

fp_ContainerObject * m_pContainer

FL_DocLayout * m_pDocLayout

FG_Fill_Type m_FillType

GR_Image * m_pImage

FG_Graphic * m_pGraphic

UT_uint32 m_iGraphicTick

bool m_bTransparentForPrint

UT_RGBColor m_color

UT_RGBColor m_TransColor

bool m_bTransColorSet

bool m_bColorSet

UT_sint32 m_iWidth

UT_sint32 m_iHeight

GR_Image ** m_pDocImage

FG_Graphic ** m_pDocGraphic

Friends

class fp_Run

Constructor & Destructor Documentation

fg_FillType::fg_FillType	(	fg_FillType *	pParent,
		fp_ContainerObject *	pContainer,
		FG_Fill_Type	iType
	)

To draw the background under text. Basic idea is to draw the colour or image defined here unless the fill type is transparent. If't transparent we recursively call it's parents until it's not transparent.

fg_FillType::~fg_FillType ( void ) [virtual]

References DELETEP, m_pGraphic, and m_pImage.

Member Function Documentation

void fg_FillType::setParent ( fg_FillType * pParent )

Set the parent of this fill class.

References m_pParent.

Referenced by fp_Line::setContainer(), fp_Container::setContainer(), fp_Run::setLine(), fp_FrameContainer::setPage(), fp_AnnotationContainer::setPage(), fp_FootnoteContainer::setPage(), fp_ShadowContainer::setPage(), and fp_Column::setPage().

void fg_FillType::setColor ( UT_RGBColor & color )

set this class to have a solid color fill

References DELETEP, FG_FILL_COLOR, m_bColorSet, m_bTransparentForPrint, m_color, m_FillType, m_pGraphic, m_pImage, and xxx_UT_DEBUGMSG.

Referenced by fl_DocSectionLayout::addOwnedPage(), fp_Run::draw(), fp_CellContainer::setBackground(), and fp_FrameContainer::setBackground().

void fg_FillType::setColor ( const char * pszColor )

set this class to have a solid color fill unless this is a NULL string pointer. This is an on-screen color only. Don't print this.

References DELETEP, FG_FILL_COLOR, FG_FILL_TRANSPARENT, m_bColorSet, m_bTransColorSet, m_bTransparentForPrint, m_color, m_FillType, m_pGraphic, m_pImage, and UT_RGBColor::setColor().

void fg_FillType::setTransColor ( UT_RGBColor & color )

set this class to have a solid color fill but not print this color.

References DELETEP, FG_FILL_COLOR, m_bTransColorSet, m_FillType, m_pGraphic, m_pImage, m_TransColor, and UT_DEBUGMSG.

Referenced by fl_DocSectionLayout::addOwnedPage(), and FL_DocLayout::updateColor().

void fg_FillType::setTransColor ( const char * pszColor )

set this class to have a solid color fill unless this is a NULL string pointer

References DELETEP, FG_FILL_COLOR, FG_FILL_TRANSPARENT, m_bColorSet, m_bTransColorSet, m_bTransparentForPrint, m_FillType, m_pGraphic, m_pImage, m_TransColor, and UT_RGBColor::setColor().

void fg_FillType::setImage	(	FG_Graphic *	pGraphic,
		GR_Image *	pImage,
		GR_Graphics *	pG,
		UT_sint32	iWidth,
		UT_sint32	iHeight
	)

set this class to have an image background for fills.

References DELETEP, FG_FILL_IMAGE, m_bTransparentForPrint, m_FillType, m_pDocImage, m_pGraphic, m_pImage, and setWidthHeight().

void fg_FillType::setTransparent ( void )

set this class to be transparent.

References DELETEP, FG_FILL_TRANSPARENT, m_bTransparentForPrint, m_FillType, m_pGraphic, and m_pImage.

void fg_FillType::setWidthHeight	(	GR_Graphics *	pG,
		UT_sint32	width,
		UT_sint32	height,
		bool	doImage = `false`
	)

References DELETEP, m_iHeight, m_iWidth, m_pDocImage, m_pGraphic, m_pImage, FG_Graphic::regenerateImage(), and GR_Image::scaleImageTo().

Referenced by fp_CellContainer::_clear(), _regenerateImage(), fp_TOCContainer::clearScreen(), fp_CellContainer::drawBroken(), fl_FrameLayout::miniFormat(), and setImage().

void fg_FillType::setWidth	(	GR_Graphics *	pG,
		UT_sint32	width
	)

References DELETEP, m_iHeight, m_iWidth, m_pDocImage, m_pGraphic, m_pImage, FG_Graphic::regenerateImage(), and GR_Image::scaleImageTo().

Referenced by fp_VerticalContainer::setWidth().

void fg_FillType::setHeight	(	GR_Graphics *	pG,
		UT_sint32	height
	)

References DELETEP, m_iHeight, m_iWidth, m_pDocImage, m_pGraphic, m_pImage, FG_Graphic::regenerateImage(), and GR_Image::scaleImageTo().

Referenced by fp_VerticalContainer::setHeight().

void fg_FillType::setDocLayout ( FL_DocLayout * pDocLayout )

Set the doc layout for this class.

References FL_DocLayout::getGraphicTick(), m_iGraphicTick, and m_pDocLayout.

Referenced by fl_DocSectionLayout::addOwnedPage(), fp_Container::fp_Container(), and fp_Run::fp_Run().

void fg_FillType::markTransparentForPrint ( void )

Set that the fill should be transparent if we're printing.

References m_bTransparentForPrint.

Referenced by fl_DocSectionLayout::addOwnedPage(), and FL_DocLayout::updateColor().

void fg_FillType::Fill	(	GR_Graphics *	pG,
		UT_sint32 &	srcX,
		UT_sint32 &	srcY,
		UT_sint32	x,
		UT_sint32	y,
		UT_sint32	width,
		UT_sint32	height
	)

Actually do the fill for this class.

References _regenerateImage(), fp_Run::_setFont(), GR_Graphics::DGP_PAPER, GR_Graphics::DGP_SCREEN, FG_FILL_COLOR, FG_FILL_IMAGE, FG_FILL_TRANSPARENT, Fill(), GR_Painter::fillRect(), FP_CONTAINER_CELL, FP_CONTAINER_FRAME, FP_CONTAINER_RUN, GR_Graphics::getClipRect(), fp_ContainerObject::getContainerType(), FL_DocLayout::getGraphicTick(), fp_CellContainer::getLeftTopOffsets(), getParent(), fp_ContainerObject::getX(), fp_FrameContainer::getXPad(), fp_ContainerObject::getY(), fp_FrameContainer::getYPad(), UT_Rect::height, UT_Rect::left, fp_Run::lookupProperties(), m_bColorSet, m_bTransColorSet, m_bTransparentForPrint, m_color, m_FillType, m_iGraphicTick, m_pContainer, m_pDocImage, m_pDocLayout, m_pImage, m_pParent, m_TransColor, GR_Graphics::queryProperties(), GR_Graphics::tlu(), UT_Rect::top, UT_Rect::width, and xxx_UT_DEBUGMSG.

Referenced by fp_CellContainer::_clear(), fp_TOCContainer::clearScreen(), fp_FrameContainer::clearScreen(), fp_EndnoteContainer::clearScreen(), fp_AnnotationContainer::clearScreen(), fp_FootnoteContainer::clearScreen(), fp_Page::draw(), fp_FrameContainer::draw(), fp_CellContainer::drawBroken(), fp_Run::Fill(), and Fill().

fg_FillType * fg_FillType::getParent ( void ) const

Return the parent of this class.

References m_pParent.

Referenced by fp_CellContainer::_clear(), fp_FrameContainer::clearScreen(), Fill(), and getColor().

FG_Fill_Type fg_FillType::getFillType ( void ) const

Return the filltype of this class.

References m_FillType.

FL_DocLayout* fg_FillType::getDocLayout ( void )

UT_RGBColor * fg_FillType::getColor ( void )

Return the most appropriate color.

References getColor(), getParent(), m_bColorSet, m_bTransColorSet, m_color, and m_TransColor.

Referenced by fp_CellContainer::_clear(), AP_Dialog_Styles::_createCharPreviewFromGC(), FV_View::_draw(), FV_View::_fixInsertionPointCoords(), AP_Dialog_Styles::_populateAbiPreview(), fp_ShadowContainer::clearHdrFtrBoundaries(), fp_FootnoteContainer::clearScreen(), fp_Run::draw(), getColor(), AP_Dialog_Styles::ModifyFont(), and s_doFontDlg().

void fg_FillType::setImagePointer	(	FG_Graphic **	pDocGraphic,
		GR_Image **	pDocImage
	)

Set a pointer to the Image pointer in fl_DocSectionLayout. This enables many pages to share the same image without having to generate a new image for every page.

References DELETEP, FG_FILL_IMAGE, m_FillType, m_pDocGraphic, m_pDocImage, m_pGraphic, and m_pImage.

Referenced by fl_DocSectionLayout::addOwnedPage(), fl_CellLayout::setCellContainerProperties(), and fl_FrameLayout::setContainerProperties().

void fg_FillType::_regenerateImage ( GR_Graphics * pG ) [private]

References DELETEP, FL_DocLayout::getGraphicTick(), m_iGraphicTick, m_iHeight, m_iWidth, m_pDocLayout, m_pGraphic, m_pImage, FG_Graphic::regenerateImage(), GR_Image::scaleImageTo(), setWidthHeight(), and UT_return_if_fail.

Referenced by Fill().

Friends And Related Function Documentation

friend class fp_Run [friend]

Member Data Documentation

fg_FillType* fg_FillType::m_pParent [private]

Referenced by Fill(), getParent(), and setParent().

fp_ContainerObject* fg_FillType::m_pContainer [private]

Referenced by Fill().

FL_DocLayout* fg_FillType::m_pDocLayout [private]

Referenced by _regenerateImage(), Fill(), and setDocLayout().

FG_Fill_Type fg_FillType::m_FillType [private]

Referenced by Fill(), getFillType(), setColor(), setImage(), setImagePointer(), setTransColor(), and setTransparent().

GR_Image* fg_FillType::m_pImage [private]

Referenced by _regenerateImage(), Fill(), setColor(), setHeight(), setImage(), setImagePointer(), setTransColor(), setTransparent(), setWidth(), setWidthHeight(), and ~fg_FillType().

FG_Graphic* fg_FillType::m_pGraphic [private]

Referenced by _regenerateImage(), setColor(), setHeight(), setImage(), setImagePointer(), setTransColor(), setTransparent(), setWidth(), setWidthHeight(), and ~fg_FillType().

UT_uint32 fg_FillType::m_iGraphicTick [private]

Referenced by _regenerateImage(), Fill(), and setDocLayout().

bool fg_FillType::m_bTransparentForPrint [private]

Referenced by Fill(), markTransparentForPrint(), setColor(), setImage(), setTransColor(), and setTransparent().

UT_RGBColor fg_FillType::m_color [private]

Referenced by Fill(), getColor(), and setColor().

UT_RGBColor fg_FillType::m_TransColor [private]

Referenced by Fill(), getColor(), and setTransColor().

bool fg_FillType::m_bTransColorSet [private]

Referenced by Fill(), getColor(), setColor(), and setTransColor().

bool fg_FillType::m_bColorSet [private]

Referenced by Fill(), getColor(), setColor(), and setTransColor().

UT_sint32 fg_FillType::m_iWidth [private]

Referenced by fp_Run::_getWidth(), _regenerateImage(), fp_Run::_setWidth(), setHeight(), setWidth(), and setWidthHeight().

UT_sint32 fg_FillType::m_iHeight [private]

Referenced by fp_Run::_getHeight(), _regenerateImage(), fp_Run::_setHeight(), setHeight(), setWidth(), and setWidthHeight().

GR_Image** fg_FillType::m_pDocImage [private]

Referenced by Fill(), setHeight(), setImage(), setImagePointer(), setWidth(), and setWidthHeight().

FG_Graphic** fg_FillType::m_pDocGraphic [private]

Referenced by setImagePointer().

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


Public Member Functions
	fg_FillType (fg_FillType pParent, fp_ContainerObject pContainer, FG_Fill_Type iType)
virtual	~fg_FillType (void)
void	setParent (fg_FillType *pParent)
void	setColor (UT_RGBColor &color)
void	setColor (const char *pszColor)
void	setTransColor (UT_RGBColor &color)
void	setTransColor (const char *pszColor)
void	setImage (FG_Graphic pGraphic, GR_Image pImage, GR_Graphics *pG, UT_sint32 width, UT_sint32 height)
void	setTransparent (void)
void	setWidthHeight (GR_Graphics *pG, UT_sint32 width, UT_sint32 height, bool doImage=false)
void	setWidth (GR_Graphics *pG, UT_sint32 width)
void	setHeight (GR_Graphics *pG, UT_sint32 height)
void	setDocLayout (FL_DocLayout *pDocLayout)
void	markTransparentForPrint (void)
void	Fill (GR_Graphics *pG, UT_sint32 &srcX, UT_sint32 &srcY, UT_sint32 x, UT_sint32 y, UT_sint32 width, UT_sint32 height)
fg_FillType *	getParent (void) const
FG_Fill_Type	getFillType (void) const
FL_DocLayout *	getDocLayout (void)
UT_RGBColor *	getColor (void)
void	setImagePointer (FG_Graphic pDocGraphic, GR_Image pDocImage)
Private Member Functions
void	_regenerateImage (GR_Graphics *pG)
Private Attributes
fg_FillType *	m_pParent
fp_ContainerObject *	m_pContainer
FL_DocLayout *	m_pDocLayout
FG_Fill_Type	m_FillType
GR_Image *	m_pImage
FG_Graphic *	m_pGraphic
UT_uint32	m_iGraphicTick
bool	m_bTransparentForPrint
UT_RGBColor	m_color
UT_RGBColor	m_TransColor
bool	m_bTransColorSet
bool	m_bColorSet
UT_sint32	m_iWidth
UT_sint32	m_iHeight
GR_Image **	m_pDocImage
FG_Graphic **	m_pDocGraphic
Friends
class	fp_Run