Group Class Documentation
class Group : ElementNamespace:datalogics_interface
- Inherits from:
Element
Detailed Description
A set of elements to be used within a PDF document.
A Group represents objects in a content object, but it resides in memory.
Therefore the group has no state and is not represented in any way in a PDF content stream. When used in a Clip, a group is used to associate Text objects into a single clipping object.
Referenced by
Constructor & Destructor Documentation
Member Function Documentation
clear_content
void clear_content()Returns:
voidRemoves the content from this group.
clone
std::unique_ptr< Element > clone(ElementCloneFlags flags)Parameters
flags: ElementCloneFlags
Returns:
std::unique_ptr< Element >The copied element.
Makes a copy of the element.
Make a copy of an element to obtain a new element that has a distinct set of attributes.
Note: TextRun objects may not be cloned.
clone
std::unique_ptr< Group > clone()Returns:
std::unique_ptr< Group >The copied group.
Makes a copy of the group.
Make a copy of an group to obtain a new group that has a distinct set of attributes.
get_bounding_box
Rect get_bounding_box()Returns:
RectThe bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.
The bounding box for this element.
The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.
get_clip
std::unique_ptr< Clip > get_clip()Returns:
std::unique_ptr< Clip >The current Clip for this Element, or NULL if no clip is set.
Gets the current Clip for an Element.
get_content
std::unique_ptr< Content > get_content()Returns:
std::unique_ptr< Content >The Content associated with this Group.
Obtain the content of a Group.
get_element_type
ElementType get_element_type()Returns:
ElementTypeReturns the runtime type of this element.
get_matrix
Matrix get_matrix()Returns:
MatrixThe current transformation matrix applied to this element.
The transformation matrix for the element.
operator=
Parameters
: Group &&
Returns:
Group &rotate
void rotate(double theta)Parameters
theta: doubleThe rotation angle in degrees.
Returns:
voidRotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].
scale
void scale(double sx, double sy)Parameters
sx: doubleThe horizontal scale factor.
sy: doubleThe vertical scale factor.
Returns:
voidScale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].
set_clip
void set_clip(Clip & clip)Parameters
clip: Clip &The clip to set as the current clip for this element, or NULL to remove clipping.
Returns:
voidSets the current Clip for an Element.
set_content
void set_content(const Content & content)Parameters
content: const Content &The new Content of the group. Must not be null.
Returns:
voidSet the content of a Group.
set_matrix
void set_matrix(const Matrix & matrix)Parameters
matrix: const Matrix &The transformation matrix for the element.
Returns:
voidSet the transformation matrix for the element.
translate
void translate(double tx, double ty)Parameters
tx: doubleThe horizontal translation distance in user space units.
ty: doubleThe vertical translation distance in user space units.
Returns:
voidTranslate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].
try_as
T * try_as(typename T )Parameters
: typename T
Returns:
T *Attempt to downcast this element to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.
try_as
const T * try_as(typename T )Parameters
: typename T
Returns:
const T *Const overload of try_as(). Returns a const pointer, or nullptr.