bc Developing Plug-ins and Applications Adobe® Acrobat® SDK April 2007 Version 8.1 © 2007 Adobe Systems Incorporated. All rights reserved. Adobe® Acrobat® SDK 8.1 Developing Plug-ins and Applications for Microsoft® Windows®, Mac OS®, Linux® and UNIX® Edition 2.0, April 2007 If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement. The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide. Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permission required from the copyright owner. Any references to company names and company logos in sample material are for demonstration purposes only and are not intended to refer to any actual organization. Adobe, the Adobe logo, Acrobat, LiveCycle, PostScript, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. AIX is a trademark of International Business Machines Corporation in the United States and/or other countries. Apple and Mac OS are trademarks of Apple Computer, Inc., registered in the United States and other countries. HP-UX is a registered trademark of Hewlett-Packard Company. Intel is a registered trademark of Intel Corporation in the U.S. and other countries. JavaScript is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries. Linux is a registered trademark of Linus Torvalds. Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Red Hat is a trademark or registered trademark of Red Hat, Inc. in the United States and other countries. Solaris is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark of The Open Group in the U.S. and other countries. All other trademarks are the property of their respective owners. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users. The Software and Documentation are "Commercial Items," as that term is defined at 48 C.F.R. §2.101, consisting of "Commercial Computer Software" and "Commercial Computer Software Documentation," as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference. Contents List of Examples ......................................................................................................................... 11 Preface ........................................................................................................................................ 14 What's in this guide .....................................................................................................................................................................14 Who should read this guide? ...................................................................................................................................................14 Related documentation .............................................................................................................................................................14 1 Introduction ............................................................................................................................... 16 About plug-ins...............................................................................................................................................................................16 About the Acrobat core API......................................................................................................................................................17 Acrobat core API objects .....................................................................................................................................................18 Acrobat core API methods..................................................................................................................................................20 Data types.................................................................................................................................................................................21 About PDF Library and plug-in applications ......................................................................................................................23 Manipulating Acrobat Professional, Acrobat Standard, and Adobe Reader ....................................................23 Displaying a PDF document in an external window .................................................................................................23 Indexed searching .................................................................................................................................................................24 Modifying file access.............................................................................................................................................................24 Creating new annotation types ........................................................................................................................................24 Dynamically adding text to PDF documents ...............................................................................................................24 Understanding your target application ...............................................................................................................................24 New Acrobat core APIs ...............................................................................................................................................................25 2 Understanding Plug-ins ............................................................................................................ 27 About plug-in initialization.......................................................................................................................................................27 Plug-in loading and initialization .....................................................................................................................................28 Handshaking and Initialization .........................................................................................................................................28 Exporting HFTs........................................................................................................................................................................29 Importing HFTs and registering for notifications.......................................................................................................29 Initialization..............................................................................................................................................................................29 Unloading .................................................................................................................................................................................29 Summarizing a plug-in's life cycle ...................................................................................................................................30 Using callback functions............................................................................................................................................................30 Notifications ...................................................................................................................................................................................31 Handling events............................................................................................................................................................................31 Mouse clicks .............................................................................................................................................................................31 Adjust cursor............................................................................................................................................................................31 Key presses ...............................................................................................................................................................................31 3 Adobe Acrobat SDK Developing Plug-ins and Applications Contents 4 2 Understanding Plug-ins (Continued) Using plug-in prefixes.................................................................................................................................................................31 Obtaining a developer prefix.............................................................................................................................................31 Using a developer prefix .....................................................................................................................................................32 Plug-in name .....................................................................................................................................................................32 Menu prefixes ...................................................................................................................................................................32 Menu items prefixes .......................................................................................................................................................32 Tool prefixes ......................................................................................................................................................................32 Toolbar button prefixes.................................................................................................................................................32 Private data prefixes .......................................................................................................................................................33 Action prefixes..................................................................................................................................................................33 Annotation prefixes ........................................................................................................................................................33 HFT prefixes .......................................................................................................................................................................33 Modifying the Acrobat or Adobe Reader user interface ................................................................................................33 Adding or removing menus and menu items ........... ...