Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::ofd::graphics::OFDVideoObject类 参考
类 foxit::ofd::graphics::OFDVideoObject 继承关系图:

## Public 成员函数
| OFDVideoObject (OFDGraphicsObject object)
| 构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。 更多...
| OFDVideoObject (const OFDVideoObject &other)
| 构造函数，通过另一个OFD视频对象。 更多...
| ~OFDVideoObject ()
| 析构函数。
void | CreateBorder ()
| 创建Video对象边框。 更多...
float | GetBorderDashOffset ()
| 获取Video对象边框线条虚线样式开始的位置。 更多...
foxit::FloatArray | GetBorderDashPattern ()
| 获取Video对象边框虚线重复样式。数组中共含两个值，第一个值代表虚线线段的长度，第二个值代表虚线间隔的长度。 更多...
float | GetBorderHCornerRadius ()
| 获取Video边框横向圆角半径。 更多...
float | GetBorderLineWidth ()
| 获取Video边框线宽。 更多...
foxit::RGB | GetBorderStrokeColor ()
| 获取Video边框颜色。 更多...
float | GetBorderVCornerRadius ()
| 获取Video边框纵向圆角半径。 更多...
String | GetFormat ()
| 获取Video对象格式。 更多...
foxit::uint32 | GetResourceID ()
| 获取Video资源ID。 更多...
String | GetTitle ()
| 获取Video对象标题。 更多...
String | GetVideoData ()
| 获取Video对象中数据。 更多...
String | GetVideoType ()
| 获取Video对象类型。 更多...
bool | HasBorder ()
| 判断Video对象是否有边框。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const OFDVideoObject &other) const
| 不相等操作符。 更多...
OFDVideoObject & | operator= (const OFDVideoObject &other)
| 赋值操作符。 更多...
bool | operator== (const OFDVideoObject &other) const
| 相等操作符。 更多...
void | SetBorderCornerRadius (float h_radius, float v_radius)
| 设置Video边框横、纵向圆角半径。 更多...
void | SetBorderLineWidth (float line_width)
| 设置Video边框线宽。 更多...
void | SetBorderStrokeColor (foxit::RGB color)
| 设置Video边框颜色。 更多...
void | SetFormat (const String &format)
| 设置Video对象格式。 更多...
void | SetTitle (const String &title)
| 设置Video对象标题。 更多...
void | SetType (const String &type)
| 设置Video对象类型。 更多...
void | SetVideoFromFile (const String &file_name)
| 通过文件设置Video对象中多媒体对像。 更多...
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
| 获取当前对象的句柄。 更多...

## 额外继承的成员函数
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图元对象类型定义枚举类型. 更多...

## 详细描述

此类表示和OFD视频对象相关的方法。

## 构造及析构函数说明

## ◆ OFDVideoObject() [1/2]

foxit::ofd::graphics::OFDVideoObject::OFDVideoObject | ( | OFDGraphicsObject | object | ) |
| explicit

构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。

参数

  [in] | object | OFDGraphicsObject对象。 此对象必须是一个有效的对象，并且其类型必须是foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypeVideo，否则构造函数将抛出异常。

## ◆ OFDVideoObject() [2/2]

foxit::ofd::graphics::OFDVideoObject::OFDVideoObject | ( | const OFDVideoObject & | other | ) |

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

参数

  [in] | other | 另一个OFD视频对象。

## 成员函数说明

## ◆ CreateBorder()

void foxit::ofd::graphics::OFDVideoObject::CreateBorder | ( |  | ) |

创建Video对象边框。

返回
  无。

## ◆ GetBorderDashOffset()

float foxit::ofd::graphics::OFDVideoObject::GetBorderDashOffset | ( |  | ) |

获取Video对象边框线条虚线样式开始的位置。

返回
  图元对象虚线重复起始值。

## ◆ GetBorderDashPattern()

foxit::FloatArray foxit::ofd::graphics::OFDVideoObject::GetBorderDashPattern | ( |  | ) |

获取Video对象边框虚线重复样式。数组中共含两个值，第一个值代表虚线线段的长度，第二个值代表虚线间隔的长度。

返回
  虚线重复样式数组。

## ◆ GetBorderHCornerRadius()

float foxit::ofd::graphics::OFDVideoObject::GetBorderHCornerRadius | ( |  | ) |

获取Video边框横向圆角半径。

返回
  横向圆角半径。

## ◆ GetBorderLineWidth()

float foxit::ofd::graphics::OFDVideoObject::GetBorderLineWidth | ( |  | ) |

获取Video边框线宽。

返回
  边框线宽。

## ◆ GetBorderStrokeColor()

foxit::RGB foxit::ofd::graphics::OFDVideoObject::GetBorderStrokeColor | ( |  | ) |

获取Video边框颜色。

返回
  边框颜色。RGB格式。

## ◆ GetBorderVCornerRadius()

float foxit::ofd::graphics::OFDVideoObject::GetBorderVCornerRadius | ( |  | ) |

获取Video边框纵向圆角半径。

返回
  纵向圆角半径。

## ◆ GetFormat()

String foxit::ofd::graphics::OFDVideoObject::GetFormat | ( |  | ) |

获取Video对象格式。

返回
  对象格式。

## ◆ GetResourceID()

foxit::uint32 foxit::ofd::graphics::OFDVideoObject::GetResourceID | ( |  | ) |

获取Video资源ID。

返回
  资源ID。

## ◆ GetTitle()

String foxit::ofd::graphics::OFDVideoObject::GetTitle | ( |  | ) |

获取Video对象标题。

返回
  对象标题。

## ◆ GetVideoData()

String foxit::ofd::graphics::OFDVideoObject::GetVideoData | ( |  | ) |

获取Video对象中数据。

返回
  对象中数据。

## ◆ GetVideoType()

String foxit::ofd::graphics::OFDVideoObject::GetVideoType | ( |  | ) |

获取Video对象类型。

返回
  对象类型。

## ◆ HasBorder()

bool foxit::ofd::graphics::OFDVideoObject::HasBorder | ( |  | ) |

判断Video对象是否有边框。

返回
  是否有边框。

## ◆ IsEmpty()

bool foxit::ofd::graphics::OFDVideoObject::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator !=()

bool foxit::ofd::graphics::OFDVideoObject::operator != | ( | const OFDVideoObject & | other | ) | const

不相等操作符。

参数

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

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

## ◆ operator=()

OFDVideoObject& foxit::ofd::graphics::OFDVideoObject::operator= | ( | const OFDVideoObject & | other | ) |

赋值操作符。

参数

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

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

## ◆ operator==()

bool foxit::ofd::graphics::OFDVideoObject::operator== | ( | const OFDVideoObject & | other | ) | const

相等操作符。

参数

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

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

## ◆ SetBorderCornerRadius()

void foxit::ofd::graphics::OFDVideoObject::SetBorderCornerRadius | ( | float | h_radius,
|  | float | v_radius
| ) |  |

设置Video边框横、纵向圆角半径。

参数

  [in] | h_radius | 指定边框横向圆角半径。
  [in] | v_radius | 指定边框纵向圆角半径。

返回
  无。

## ◆ SetBorderLineWidth()

void foxit::ofd::graphics::OFDVideoObject::SetBorderLineWidth | ( | float | line_width | ) |

设置Video边框线宽。

参数

  [in] | line_width | 边框线宽。

返回
  无。

## ◆ SetBorderStrokeColor()

void foxit::ofd::graphics::OFDVideoObject::SetBorderStrokeColor | ( | foxit::RGB | color | ) |

设置Video边框颜色。

参数

  [in] | color | 颜色值。

返回
  无。

## ◆ SetFormat()

void foxit::ofd::graphics::OFDVideoObject::SetFormat | ( | const String & | format | ) |

设置Video对象格式。

参数

  [in] | format | 格式。

返回
  无。

## ◆ SetTitle()

void foxit::ofd::graphics::OFDVideoObject::SetTitle | ( | const String & | title | ) |

设置Video对象标题。

参数

  [in] | title | 标题。

返回
  无。

## ◆ SetType()

void foxit::ofd::graphics::OFDVideoObject::SetType | ( | const String & | type | ) |

设置Video对象类型。

参数

  [in] | type | 类型。

返回
  无。

## ◆ SetVideoFromFile()

void foxit::ofd::graphics::OFDVideoObject::SetVideoFromFile | ( | const String & | file_name | ) |

通过文件设置Video对象中多媒体对像。

参数

  [in] | file_name | 指定的Video文件名称。

返回
  无。