类 foxit::ofd::OFDLayer 继承关系图:

Public 类型
enum	GraphicsObjectType { e_GraphicsObjectTypeUnknown = 0, e_GraphicsObjectTypeLayer = 1, e_GraphicsObjectTypePageBlock = 2, e_GraphicsObjectTypeComposite = 3, e_GraphicsObjectTypeSvg = 4, e_GraphicsObjectTypeText = 5, e_GraphicsObjectTypePath = 6, e_GraphicsObjectTypeImage = 7, e_GraphicsObjectTypeVideo = 8 }
	OFD页面对象类型类型枚举。更多...

enum	LayerType { e_LayerTypeBackground = 0, e_LayerTypeBody = 1, e_LayerTypeForeground = 2 }
	OFD页面层类型枚举。更多...

Public 类型继承自 foxit::ofd::graphics::OFDGraphicsObject
enum	LineCapMode { e_LineCapButt = 0, e_LineCapRound = 1, e_LineCapSquare = 2 }
	OFD线端点样式枚举。更多...

enum	LineJoinMode { e_LineJoinMiter = 0, e_LineJoinRound = 1, e_LineJoinBevel = 2 }
	OFD线条连接样式枚举。更多...

enum	ObjectType { e_ObjectTypeUnknown = 0, e_ObjectTypePageBlock = 2, e_ObjectTypeComposite = 3, e_ObjectTypeSVG = 4, e_ObjectTypeText = 5, e_ObjectTypePath = 6, e_ObjectTypeImage = 7, e_ObjectTypeVideo = 8 }
	OFD图元对象类型定义枚举类型. 更多...

Public 成员函数
	OFDLayer (const OFDLayer &other)
	构造函数，通过另一个OFD层对象。更多...

	~OFDLayer ()
	析构函数。

graphics::OFDBlockObject	AddBlockObject ()
	添加图元对象-块对象。更多...

graphics::OFDCompositeObject	AddCompositeObject ()
	添加图元对象-复合对象。更多...

graphics::OFDGraphicsObject	AddGraphicsObject (GraphicsObjectType type)
	添加图元对象。更多...

graphics::OFDImageObject	AddImageObject ()
	添加图元对象-图像对象。更多...

graphics::OFDPathObject	AddPathObject ()
	添加图元对象-路径对象。更多...

graphics::OFDTextObject	AddTextObject ()
	添加图元对象-文本对象。更多...

graphics::OFDVideoObject	AddVideoObject ()
	添加图元对象-视频对象。更多...

graphics::OFDGraphicsObject	GetGraphicsObject (int index) const
	获取指定索引的图元对象。更多...

graphics::OFDGraphicsObject	GetGraphicsObjectByID (int id)
	通过ID获取图元对象。更多...

int	GetGraphicsObjectCount () const
	获取图元对象数量。更多...

int	GetGraphicsObjectIndexByName (const String &name) const
	通过名称获取图元对象索引。更多...

GraphicsObjectType	GetGraphicsObjectType (int index) const
	获取指定索引的图元对象类型。更多...

graphics::OFDBlockObject	GetPageBlock (int index) const
	获取指定索引的页面块对象。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	operator != (const OFDLayer &other) const
	不相等操作符。更多...

OFDLayer &	operator= (const OFDLayer &other)
	赋值操作符。更多...

bool	operator== (const OFDLayer &other) const
	相等操作符。更多...

void	RemoveAllGraphicsObjects ()
	删除所有图元对象。更多...

void	RemoveGraphicsObject (int index)
	删除指定索引的图元对象。更多...

void	SetType (LayerType type=e_LayerTypeBody)
	设置类型更多...

Public 成员函数继承自 foxit::ofd::graphics::OFDGraphicsObject
	OFDGraphicsObject (const OFDGraphicsObject &other)
	构造函数，通过另一个OFD图元对象。更多...

	~OFDGraphicsObject ()
	析构函数。

Actions	CreateActions ()
	创建图元对象动作集合对象。更多...

Actions	GetActions ()
	获取图元对象的动作集合。更多...

foxit::uint8	GetAlpha ()
	获取图元对象alpha属性。更多...

BorderInfo	GetBorderInfo ()
	获取图元对象边框信息(只有Image和Video对象可能会存在边框)。更多...

foxit::RectF	GetBoundary ()
	获取图元对象矩形外接框。更多...

float	GetDashOffset ()
	获取图元对象虚线重复样式。更多...

foxit::FloatArray	GetDashPattern ()
	获取图元对象虚线重复样式数组。更多...

foxit::RGB	GetFillColor ()
	获取图元对象填充颜色。更多...

foxit::uint32	GetID ()
	获取图元对象资源ID。更多...

LineCapMode	GetLineCap ()
	获取图元对象线帽样式。更多...

LineJoinMode	GetLineJoin ()
	获取线条连接样式。更多...

float	GetLineWidth ()
	获取图元对象线宽。更多...

foxit::Matrix	GetMatrix ()
	获取图元对象矩阵。更多...

float	GetMiterLimit ()
	获取图元对象斜切限制值。更多...

String	GetName ()
	获取图元对象名称。更多...

int	GetPageIndex ()
	获取图元对象所在页面的索引号。更多...

foxit::RGB	GetStrokeColor ()
	获取图元对象勾边颜色。更多...

ObjectType	GetType ()
	获取图元对象类型。更多...

bool	HasBorder ()
	判断图元对象是否有边框。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	IsVisible ()
	获取图元对象可见性属性。更多...

bool	operator != (const OFDGraphicsObject &other) const
	不相等操作符。更多...

OFDGraphicsObject &	operator= (const OFDGraphicsObject &other)
	赋值操作符。更多...

bool	operator== (const OFDGraphicsObject &other) const
	相等操作符。更多...

void	SetAlpha (foxit::uint8 alpha)
	设置图元对象alpha属性。更多...

void	SetBorderInfo (const BorderInfo &border_info)
	设置图元对象边框信息。更多...

void	SetBoundary (const RectF &boundary)
	设置图元对象矩形外接框。更多...

void	SetDashOffset (float dash_offset)
	设置图元对象虚线重复样式起始值。更多...

void	SetDashPattern (float dash_offset, const foxit::FloatArray &dash_offset_array)
	设置图元对象虚线重复样式。更多...

void	SetFillColor (foxit::uint32 fill_color)
	设置图元对象填充颜色。更多...

void	SetLineCap (LineCapMode line_cap=e_LineCapButt)
	设置图元对象线帽样式。更多...

void	SetLineJoin (LineJoinMode line_join=e_LineJoinMiter)
	设置线条连接样式。更多...

void	SetLineWidth (float line_width)
	设置图元对象线宽。更多...

void	SetMatrix (const Matrix &mt)
	设置图元对象矩阵。更多...

void	SetMiterLimit (float miter_limit)
	设置图元对象斜切限制值。更多...

void	SetName (const String &name)
	设置图元对象名称。更多...

void	SetStrokeColor (foxit::uint32 stroke_color)
	设置图元对象勾边颜色。更多...

void	SetVisible (bool visible)
	设置图元对象可见性属性。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

此类表示和OFD层相关的操作。

成员枚举类型说明

◆ GraphicsObjectType

enum foxit::ofd::OFDLayer::GraphicsObjectType

OFD页面对象类型类型枚举。

该枚举值应单独使用。

枚举值
e_GraphicsObjectTypeUnknown	未知类型。
e_GraphicsObjectTypeLayer	层类型。
e_GraphicsObjectTypePageBlock	页面块对象。
e_GraphicsObjectTypeComposite	复合对象。
e_GraphicsObjectTypeSvg	矢量对象。
e_GraphicsObjectTypeText	文本对象。
e_GraphicsObjectTypePath	路径对象。
e_GraphicsObjectTypeImage	图像类型。
e_GraphicsObjectTypeVideo	视频对象。

◆ LayerType

enum foxit::ofd::OFDLayer::LayerType

OFD页面层类型枚举。

该枚举值应单独使用。

枚举值
e_LayerTypeBackground	背景层。
e_LayerTypeBody	正文层。
e_LayerTypeForeground	前景层。

构造及析构函数说明

◆ OFDLayer()

foxit::ofd::OFDLayer::OFDLayer ( const OFDLayer & other )

构造函数，通过另一个OFD层对象。

参数

[in] other 另一个OFD层对象。

成员函数说明

◆ AddBlockObject()

graphics::OFDBlockObject foxit::ofd::OFDLayer::AddBlockObject ( )

添加图元对象-块对象。

返回: 新添加的块对象。

◆ AddCompositeObject()

graphics::OFDCompositeObject foxit::ofd::OFDLayer::AddCompositeObject ( )

添加图元对象-复合对象。

返回: 新添加的复合对象。

◆ AddGraphicsObject()

graphics::OFDGraphicsObject foxit::ofd::OFDLayer::AddGraphicsObject ( GraphicsObjectType type )

添加图元对象。

参数

[in] type 图元对象类型。请参考从 foxit::ofd::OFDLayer::e_GraphicsObjectTypeLayer 开始的值，这应该是这些值中的一个。

返回: 新添加的图元对象。

◆ AddImageObject()

graphics::OFDImageObject foxit::ofd::OFDLayer::AddImageObject ( )

添加图元对象-图像对象。

返回: 新添加的图像对象。

◆ AddPathObject()

graphics::OFDPathObject foxit::ofd::OFDLayer::AddPathObject ( )

添加图元对象-路径对象。

返回: 新添加的路径对象。

◆ AddTextObject()

graphics::OFDTextObject foxit::ofd::OFDLayer::AddTextObject ( )

添加图元对象-文本对象。

返回: 新添加的文本对象。

◆ AddVideoObject()

graphics::OFDVideoObject foxit::ofd::OFDLayer::AddVideoObject ( )

添加图元对象-视频对象。

返回: 新添加的视频对象。

◆ GetGraphicsObject()

graphics::OFDGraphicsObject foxit::ofd::OFDLayer::GetGraphicsObject ( int index ) const

获取指定索引的图元对象。

参数

[in] index 指定图元对象的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OFDLayer::GetGraphicsObjectCount 返回。

返回: 图元对象。

◆ GetGraphicsObjectByID()

graphics::OFDGraphicsObject foxit::ofd::OFDLayer::GetGraphicsObjectByID ( int id )

通过ID获取图元对象。

参数

[in] id 图元对象ID。

返回: 图元对象。

◆ GetGraphicsObjectCount()

int foxit::ofd::OFDLayer::GetGraphicsObjectCount ( ) const

获取图元对象数量。

返回: 图元对象数量。

◆ GetGraphicsObjectIndexByName()

int foxit::ofd::OFDLayer::GetGraphicsObjectIndexByName ( const String & name ) const

通过名称获取图元对象索引。

参数

[in] name 图元对象名称。

返回: 图元对象索引。若未找到则返回-1。

◆ GetGraphicsObjectType()

GraphicsObjectType foxit::ofd::OFDLayer::GetGraphicsObjectType ( int index ) const

获取指定索引的图元对象类型。

参数

[in] index 指定图元对象的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OFDLayer::GetGraphicsObjectCount 返回。

返回: 图元对象类型。请参考从 foxit::ofd::OFDLayer::e_GraphicsObjectTypeUnknown 开始的值，应该是这些值中的一个。

◆ GetPageBlock()

graphics::OFDBlockObject foxit::ofd::OFDLayer::GetPageBlock ( int index ) const

获取指定索引的页面块对象。

参数

[in] index 指定页面块对象的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OFDLayer::GetGraphicsObjectCount 返回。

返回: 页面块对象。

◆ IsEmpty()

bool foxit::ofd::OFDLayer::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回: true 表示当前对象为空，false 表示不为空。

◆ operator !=()

bool foxit::ofd::OFDLayer::operator != ( const OFDLayer & other ) const

不相等操作符。

参数

[in] other 另一个OFD层对象。此函数将检查当前对象是否不等于这个对象。

返回: true 表示不相等，false 表示相等。

◆ operator=()

OFDLayer& foxit::ofd::OFDLayer::operator= ( const OFDLayer & other )

赋值操作符。

参数

[in] other 另一个OFD层对象，其值将被赋给当前对象。

返回: 当前对象自身的引用。

◆ operator==()

bool foxit::ofd::OFDLayer::operator== ( const OFDLayer & other ) const

相等操作符。

参数

[in] other 另一个OFD层对象。此函数将检查当前对象是否等于这个对象。

返回: true 表示相等，false 表示不相等。

◆ RemoveAllGraphicsObjects()

void foxit::ofd::OFDLayer::RemoveAllGraphicsObjects ( )

删除所有图元对象。

返回: 无。

◆ RemoveGraphicsObject()

void foxit::ofd::OFDLayer::RemoveGraphicsObject ( int index )

删除指定索引的图元对象。

参数

[in] index 指定图元对象的索引。有效范围：从0到(count-1)。 count 由函数 foxit::ofd::OFDLayer::GetGraphicsObjectCount 返回。

返回: 无。

◆ SetType()

void foxit::ofd::OFDLayer::SetType ( LayerType type = e_LayerTypeBody )

设置类型

参数

[in] type 类型。请参考从 foxit::ofd::OFDLayer::e_LayerTypeBackground 开始的值，这应该是这些值中的一个。默认值为 foxit::ofd::OFDLayer::e_LayerTypeBody 。

返回: 无。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ GraphicsObjectType

◆ LayerType

构造及析构函数说明

◆ OFDLayer()

成员函数说明

◆ AddBlockObject()

◆ AddCompositeObject()

◆ AddGraphicsObject()

◆ AddImageObject()

◆ AddPathObject()

◆ AddTextObject()

◆ AddVideoObject()

◆ GetGraphicsObject()

◆ GetGraphicsObjectByID()

◆ GetGraphicsObjectCount()

◆ GetGraphicsObjectIndexByName()

◆ GetGraphicsObjectType()

◆ GetPageBlock()

◆ IsEmpty()

◆ operator !=()

◆ operator=()

◆ operator==()

◆ RemoveAllGraphicsObjects()

◆ RemoveGraphicsObject()

◆ SetType()