ITransforms provide a method of applying common operations on DOM objects such as brushes, nodes, colors, colorspaces or entire trees. Not all transforms will operate on all kinds of objects, as noted in their descriptions.
More...
#include <transforms.h>
|
| virtual IDOMBrushPtr | transform (const IDOMBrushPtr &brush, eBrushUsage usage=eBUGeneral, const CTransformState &state=CTransformState())=0 |
| | Apply the transform to the given brush, if applicable. These transforms are thread safe. More...
|
| |
| virtual IDOMImagePtr | transform (const IDOMImagePtr &image, const CTransformState &state=CTransformState())=0 |
| | Apply the transform to the given image, if applicable. These transforms are thread safe. More...
|
| |
| virtual IDOMColorPtr | transform (const IDOMColorPtr &color, const CTransformState &state=CTransformState())=0 |
| | Apply the transform to the given color, if applicable. These transforms are thread safe. More...
|
| |
| virtual IDOMColorSpacePtr | transform (const IDOMColorSpacePtr &colorSpace, const CTransformState &state=CTransformState())=0 |
| | Apply the transform to the given colorspace, if applicable. These transforms are thread safe. More...
|
| |
| virtual IDOMNodePtr | transform (const IDOMNodePtr &node, bool &changed, bool transformChildren=true, const CTransformState &state=CTransformState())=0 |
| | Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. More...
|
| |
| virtual void | transformPage (const IPagePtr &page, bool transformContent=true, bool transformAnnotations=true)=0 |
| | Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances. More...
|
| |
|
virtual void | flushCaches ()=0 |
| | Flush the caches used by the transform. Most transforms cache recently transformed results to improve the performance of repeated transformations of equivalent results. However, it is possible that some cached results may point to entities that no longer exist, such as content inside an XPS file that no longer exists. If you are deleting or replacing files where transforms have been used, it is advisable to invoke this routine to clear the caches.
|
| |
| virtual void | setProgressMonitor (const IProgressMonitorPtr &progressMonitor)=0 |
| | Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform. More...
|
| |
|
virtual void | addRef () const =0 |
| | Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
| |
| virtual bool | decRef () const =0 |
| | Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to. More...
|
| |
ITransforms provide a method of applying common operations on DOM objects such as brushes, nodes, colors, colorspaces or entire trees. Not all transforms will operate on all kinds of objects, as noted in their descriptions.
ITransform instances attempt to return the same object for cases where identical transforms have been applied. For example, if an image has been previously transformed, the same object will be returned as the previous call if the results would be identical.
◆ setProgressMonitor()
| virtual void JawsMako::ITransform::setProgressMonitor |
( |
const IProgressMonitorPtr & |
progressMonitor | ) |
|
|
pure virtual |
Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform.
- Parameters
-
| progressMonitor | The progress monitor which allows aborting an operation or registering a progress callback. |
◆ transform() [1/5]
Apply the transform to the given brush, if applicable. These transforms are thread safe.
- Parameters
-
| brush | The brush to be processed. |
| usage | What the brush is to be used for. |
| state | The active CTransformState when this brush is encountered. Not all transforms require this information. |
- Returns
- IDOMBrushPtr The result. If modifications have been applied the result will be a new brush. If NULL, this indicates that the brush should be dropped entirely.
◆ transform() [2/5]
Apply the transform to the given color, if applicable. These transforms are thread safe.
- Parameters
-
| color | The color to be processed. |
| state | The active CTransformState when this color is encountered. Not all transforms require this information. |
- Returns
- IDOMColorPtr The result. If modifications have been applied the result will be a new color. If NULL, this indicates that the color should be dropped entirely.
◆ transform() [3/5]
Apply the transform to the given colorspace, if applicable. These transforms are thread safe.
- Parameters
-
| colorSpace | The colorSpace to be processed. |
| state | The active CTransformState when this color space is encountered. Not all transforms require this information. |
- Returns
- IDOMColorSpacePtr The result. If modifications have been applied the result will be a new color space.
◆ transform() [4/5]
Apply the transform to the given image, if applicable. These transforms are thread safe.
- Parameters
-
| image | The image to be processed. |
| state | The active CTransformState when this image is encountered. Not all transforms require this information. |
- Returns
- IDOMImagehPtr The result. If modifications have been applied the result will be a new image. If NULL, this indicates that the image should be dropped entirely.
◆ transform() [5/5]
| virtual IDOMNodePtr JawsMako::ITransform::transform |
( |
const IDOMNodePtr & |
node, |
|
|
bool & |
changed, |
|
|
bool |
transformChildren = true, |
|
|
const CTransformState & |
state = CTransformState() |
|
) |
| |
|
pure virtual |
Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time.
- Parameters
-
| node | The node to be processed. |
| changed | Will be set to true on return if any changes have been made. |
| transformChildren | If true, the transform will also apply to any children of the node. For some transforms, this must be set; see the description of the individual transforms for details. |
| state | The active CTransformState when this node is encountered. Not all transforms require this information. |
- Returns
- IDOMNodePtr The result. It may be a new node, a modified version, or NULL indicating that the node is to be dropped entirely.
◆ transformPage()
| virtual void JawsMako::ITransform::transformPage |
( |
const IPagePtr & |
page, |
|
|
bool |
transformContent = true, |
|
|
bool |
transformAnnotations = true |
|
) |
| |
|
pure virtual |
Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances.
- Parameters
-
| page | The page to be processed. |
| transformContent | If true, apply the transform to the page content |
| transformAnnotations | If true, apply the transform to the annotations |
The documentation for this class was generated from the following file:
Public Member Functions inherited from IRCObject