OpenDoc Class Reference For the Mac OS Addison-Wesley Publishing Company Reading, Massachusetts Menlo Park, California New York Don Mills, Ontario Wokingham, England Amsterdam Bonn Sydney Singapore Tokyo Madrid San Juan Paris Seoul Milan Mexico City Taipei This document was created with FrameMaker 4.0.4 Apple Computer, Inc. Apple, the Apple logo, AppleScript, ORIGINAL RETAIL PURCHASE OF 1995 Apple Computer, Inc. Bento, LaserWriter, Macintosh, THIS PRODUCT. All rights reserved. OpenDoc, and QuickTime are Even though Apple has reviewed this No part of this publication may be trademarks of Apple Computer, Inc., manual, APPLE MAKES NO reproduced, stored in a retrieval registered in the United States and WARRANTY OR REPRESENTATION, system, or transmitted, in any form other countries. EITHER EXPRESS OR IMPLIED, WITH or by any means, mechanical, Apple Press, the Apple Press RESPECT TO THIS MANUAL, ITS electronic, photocopying, recording, signature, Finder, Mac, and QUALITY, ACCURACY, or otherwise, without prior written QuickDraw are trademarks of Apple MERCHANTABILITY, OR FITNESS permission of Apple Computer, Inc., Computer, Inc. FOR A PARTICULAR PURPOSE. AS A except to make a backup copy of Adobe, Acrobat, and PostScript are RESULT, THIS MANUAL IS SOLD “AS any documentation provided on trademarks of Adobe Systems IS,” AND YOU, THE PURCHASER, CD-ROM. Incorporated or its subsidiaries and ARE ASSUMING THE ENTIRE RISK The Apple logo is a trademark of may be registered in certain AS TO ITS QUALITY AND Apple Computer, Inc. jurisdictions. ACCURACY. Use of the “keyboard” Apple logo Helvetica and Palatino are IN NO EVENT WILL APPLE BE (Option-Shift-K) for commercial registered trademarks of LIABLE FOR DIRECT, INDIRECT, purposes without the prior written Linotype-Hell AG and/or its SPECIAL, INCIDENTAL, OR consent of Apple may constitute subsidiaries. CONSEQUENTIAL DAMAGES trademark infringement and unfair ITC Zapf Dingbats is a registered RESULTING FROM ANY DEFECT OR competition in violation of federal trademark of International Typeface INACCURACY IN THIS MANUAL, and state laws. Corporation. even if advised of the possibility of such damages. No licenses, express or implied, are QuickView is licensed from Altura granted with respect to any of the Software, Inc. THE WARRANTY AND REMEDIES technology described in this book. SOM, SOMobjects, and System SET FORTH ABOVE ARE EXCLUSIVE Apple retains all intellectual AND IN LIEU OF ALL OTHERS, ORAL property rights associated with the Object Model are licensed trademarks of IBM Corporation. OR WRITTEN, EXPRESS OR IMPLIED. technology described in this book. No Apple dealer, agent, or employee is This book is intended to assist Simultaneously published in the authorized to make any modification, application developers to develop United States and Canada. extension, or addition to this warranty. applications only for Apple-labeled LIMITED WARRANTY ON MEDIA Some states do not allow the exclusion or Apple-licensed computers. AND REPLACEMENT Every effort has been made to or limitation of implied warranties or ALL IMPLIED WARRANTIES ON ensure that the information in this liability for incidental or consequential THIS MANUAL, INCLUDING manual is accurate. Apple is not damages, so the above limitation or IMPLIED WARRANTIES OF responsible for typographical errors. exclusion may not apply to you. This MERCHANTABILITY AND FITNESS warranty gives you specific legal rights, Apple Computer, Inc. FOR A PARTICULAR PURPOSE, ARE and you may also have other rights 1 Infinite Loop LIMITED IN DURATION TO NINETY which vary from state to state. Cupertino, CA 95014 (90) DAYS FROM THE DATE OF THE 408-996-1010 This document was created with FrameMaker 4.0.4 Contents Preface About This Book 29 Organization 29 Class Descriptions 30 Method Descriptions 31 OpenDoc and SOMobjects 32 Conventions Used in This Book 34 Component Integration Laboratories 35 Part 1 Classes and Methods 37 ODAddressDesc 39 InitODAddressDesc 40 ODAppleEvent 41 InitODAppleEvent 42 ODArbitrator 43 AcquireFocusOwner 45 CreateFocusSet 46 CreateOwnerIterator 47 GetFocusModule 48 IsFocusExclusive 49 IsFocusRegistered 50 RegisterFocus 50 RelinquishFocus 51 RelinquishFocusSet 52 RequestFocus 53 RequestFocusSet 54 3 This document was created with FrameMaker 4.0.4 TransferFocus 56 TransferFocusSet 57 UnregisterFocus 58 ODBinding 59 ChooseEditorForPart 60 ODCanvas 61 AcquireBiasTransform 65 AcquireOwner 66 AcquireUpdateShape 67 GetFacet 67 GetGXViewport 68 GetPlatformCanvas 69 GetPlatformPrintJob 70 GetQDPort 71 HasPlatformCanvas 72 HasPlatformPrintJob 73 Invalidate 74 IsDynamic 74 IsOffscreen 75 ResetUpdateShape 75 SetBiasTransform 76 SetFacet 77 SetOwner 77 SetPlatformCanvas 78 SetPlatformPrintJob 79 Validate 80 ODClipboard 81 ActionDone 84 ActionRedone 85 ActionUndone 86 Clear 87 DraftClosing 88 DraftSaved 89 ExportClipboard 89 GetContentStorageUnit 90 4 GetUpdateID 91 SetPlatformClipboard 92 ShowPasteAsDialog 93 ODContainer 96 AcquireDocument 98 GetID 99 GetName 99 GetStorageSystem 100 SetName 100 ODDesc 102 GetDescType 103 GetRawData 104 InitODDesc 104 SetDescType 105 SetRawData 105 ODDescList 106 InitODDescList 107 ODDispatcher 108 AddDispatchModule 111 AddMonitor 112 Dispatch 113 Exit 114 GetDispatchModule 115 GetMouseRegion 116 GetSleepTime 116 InvalidateFacetUnderMouse 117 Redispatch 117 RegisterIdle 119 RemoveDispatchModule 119 RemoveMonitor 120 SetIdleFrequency 121 SetMouseRegion 122 ShouldExit 122 UnregisterIdle 123 Yield 124 5 ODDispatchModule 125 Dispatch 127 InitDispatchModule 128 ODDocument 130 AcquireBaseDraft 132 AcquireDraft 134 CollapseDrafts 136 CreateDraft 137 Exists 138 GetContainer 140 GetID 140 GetName 141 SaveToAPrevDraft 142 SetBaseDraftFromForeignDraft 143 SetName 143 ODDraft 145 AbortClone 149 AcquireDraftProperties 150 AcquireFrame 151 AcquireLink 152 AcquireLinkSource 153 AcquirePart 154 AcquirePersistentObject 155 AcquireStorageUnit 156 BeginClone 157 ChangedFromPrev 158 Clone 159 CreateFrame 162 CreateLinkSource 163 CreateLinkSpec 164 CreatePart 166 CreateStorageUnit 167 EndClone 167 Externalize 169 GetDocument 169 GetID 170 6 GetPermissions 170 GetPersistentObjectID 171 IsValidID 172 ReleasePart 173 RemoveChanges 173 RemoveFrame 174 RemoveFromDocument 175 RemoveLink 175 RemoveLinkSource 176 RemovePart 177 RemoveStorageUnit 178 SaveToAPrevious 179 SetChangedFromPrev 180 WeakClone 181 ODDragAndDrop 184 Clear 186 GetContentStorageUnit 187 GetDragAttributes 187 GetDragReference 189 ShowPasteAsDialog 189 StartDrag 192 ODDragItemIterator 194 First 195 IsNotComplete 196 Next 197 ODEmbeddedFramesIterator 198 CheckValid 201 First 202 InitEmbeddedFramesIterator 203 IsNotComplete 204 IsValid 205 Next 205 PartRemoved 206 ODExtension 208 BaseRemoved 211 7 CheckValid 212 GetBase 213 InitExtension 213 IsValid 214 ODFacet 215 AcquireActiveShape 220 AcquireAggregateClipShape 221 AcquireClipShape 222 AcquireContentTransform 222 AcquireExternalTransform 223 AcquireFrameTransform 224 AcquireWindowAggregateClipShape 225 AcquireWindowContentTransform 226 AcquireWindowFrameTransform 227 ActiveBorderContainsPoint 228 ChangeActiveShape 229 ChangeCanvas 229 ChangeGeometry 230 ChangeHighlight 231 ContainsPoint 232 CreateCanvas 232 CreateEmbeddedFacet 234 CreateFacetIterator 235 CreateShape 236 CreateTransform 237 Draw 238 DrawActiveBorder 238 DrawChildren 239 DrawChildrenAlways 240 DrawnIn 241 GetCanvas 241 GetContainingFacet 242 GetFrame 242 GetHighlight 243 GetPartInfo 243 GetWindow 244 HasCanvas 245 8 Invalidate 245 InvalidateActiveBorder 246 IsSelected 247 MoveBefore 247 MoveBehind 248 RemoveFacet 249 SetPartInfo 250 SetSelected 250 Update 251 Validate 252 ODFacetIterator 253 First 254 IsNotComplete 255 Next 256 SkipChildren 257 ODFocusModule 258 AbortRelinquishFocus 261 AcquireFocusOwner 262 BeginRelinquishFocus 263 CommitRelinquishFocus 264 CreateOwnerIterator 265 InitFocusModule 266 IsFocusExclusive 267 SetFocusOwnership 268 TransferFocusOwnership 269 UnsetFocusOwnership 270 ODFocusOwnerIterator 272 First 274 InitFocusOwnerIterator 275 IsNotComplete 276 Next 277 ODFocusSet 279 Add 280 Contains 281 CreateIterator 282 9 Remove 282 ODFocusSetIterator 284 First 285 IsNotComplete 286 Next 286 ODFrame 288 AcquireContainingFrame 295 AcquireFrameShape 296 AcquireInternalTransform 297 AcquirePart 297 AcquireUsedShape 298 AcquireWindow 299 ChangeContentExtent 299 ChangeFrameShape 300 ChangeInternalTransform 301 ChangeLinkStatus 302 ChangePart 303 ChangePresentation 304 ChangeSequenceNumber 305 ChangeUsedShape 305 ChangeViewType 306 Close 307 ContentUpdated 308 CreateFacetIterator 308 CreateShape 309 CreateTransform 310 DoesPropagateEvents 310 DrawActiveBorder 311 EditInLink 311 FacetAdded 312 FacetRemoved 313 GetContentExtent 313 GetFrameGroup 314 GetLinkStatus 314 GetPartInfo 315 GetPresentation 316 10 GetSequenceNumber 316 GetViewType 316 Invalidate 317 InvalidateActiveBorder 318 IsDragging 318 IsDroppable 319 IsFrozen 320 IsInLimbo 320 IsOverlaid 321 IsRoot 321 IsSubframe 322 Remove 322 RequestFrameShape 323 SetContainingFrame 324 SetDragging 325 SetDroppable 326 SetFrameGroup 326 SetFrozen 327 SetInLimbo 327 SetPartInfo 328 SetPresentation 328 SetPropagateEvents 329 SetSubframe 330 SetViewType 330 SetWindow 331 Validate 332 ODFrameFacetIterator 333 First 334 IsNotComplete 335 Next 335 ODInfo 337 ShowPartFrameInfo 338 ODLink 339 GetChangeTime 342 GetContentStorageUnit 343 11 GetUpdateID 344 Lock 345 RegisterDependent 346 ShowLinkDestinationInfo 347 ShowSourceContent 349 Unlock 351 UnregisterDependent 351 ODLinkManager 353 AnyLinkImported 355 DraftClosing