 | InDesign SDK 20.5 |
| InDesign SDK 20.5 |
#include <IPageItemScrapData.h>
Public Types | |
| enum | { kScrapType = 'PMLY' } |
| enum | { kDefaultIID = IID_IPAGEITEMSCRAPDATA } |
Public Member Functions | |
| virtual void | Replace (const UIDList &newList)=0 |
| virtual void | Append (UID newItem)=0 |
| virtual void | Append (const UIDList &newList)=0 |
| virtual void | Clear ()=0 |
| virtual bool16 | IsEmpty () const =0 |
| virtual UIDList * | CreateUIDList () const =0 |
| virtual UIDRef | GetRootNode () const =0 |
| virtual void | SetRootNode (const UIDRef &newRoot)=0 |
| virtual bool16 | GetIsGuide () const =0 |
| virtual void | SetIsGuide (bool16 isGuide)=0 |
| virtual bool16 | GetCenterItemOnPaste () const =0 |
| virtual void | SetCenterItemOnPaste (bool16 centerItem)=0 |
| virtual PMPoint | GetPasteInsideOffset (void) const =0 |
| virtual void | SetPasteInsideOffset (const PMPoint &offset)=0 |
| virtual PMMatrix | GetPasteInsideRelativeTransform (void) const =0 |
| virtual void | SetPasteInsideRelativeTransform (const PMMatrix &transform)=0 |
 Public Member Functions inherited from IPMUnknown | |
| virtual IPMUnknown * | QueryInterface (PMIID interfaceID) const =0 |
| virtual void | AddRef () const =0 |
| virtual void | Release () const =0 |
IPageItemScrapData interface, is used to represent pageitems in a scrap database by the data exchange framework. This interface can be found on the PageItemScrapHandler boss as well as several other handler bosses that also store page item data. The class PageItemScrapData provides the necessary implementation.
Note that the pageitems are not required to live in the same database as this interface does. The pageitems can either exist in the scrap database (as is the case for the clipboard) in another document (typical when dragging from ne document to another), etc.
| pure virtual |
Append an item to the scrap data
| newItem | INOUT DESCRIPTION |
| pure virtual |
Append a list of items to the scrap data
| newList | IN items to add to the list (should be in the same database as those items already there) |
| pure virtual |
Remove all of the page items (release references or delete actual page items)
| pure virtual |
Get a copy of the list of items on the scrap.
| pure virtual |
When pasting, should the pageitems be centered on the page
| pure virtual |
Does the scrap contain guides rather than pageitems?
| pure virtual |
For Paste Inside: Get the offset, saved at copy time of the item within it's parent.
| pure virtual |
For Paste Inside: Get the transform set at copy time of the item(s) parent.
| pure virtual |
Get the parent to be used when adding items to the scrap
| pure virtual |
Are there any pageitems in the scrap data
| pure virtual |
Specify the pageitems to be remembered. Note that you MUST call Replace first to establish which database the items exist in. You can then optionally call Append to add other items.
| newList | IN list of pageitems |
| pure virtual |
Set whether the should the pageitems be centered on the page, when pasting.
| pure virtual |
Set the flag that records whether the items in the scrap are guides rather than pageitems.
| pure virtual |
For Paste Inside: Set the offset at copy time of the top left of the item we are copying to the top left of its parent. The Offset calculation should be done in the coordinate space of the parent. At PasteInside time, this Offset will be transformed into PasteBoard coordinates using the transform of the frame we are pasting into in order to calculate an offset in PasteBoard coordinates which can be used to move the pasted item such that it maintains the same offset with respect to its new frame as when originally copied.
| offset | IN the offset |
| pure virtual |
For Paste Inside: Set the transform at copy time of the item(s) parent.
| pure virtual |
Set the parent to be used when adding page items to the scrap. Used when copying or otherwise creating pageitems that reside in the scrap database.
| newRoot | IN the root node |
1.8.3.1 
