Palm OS® SDK Reference Document Number 3003-002 Print Date 3/00 CONTRIBUTORS Written by Christopher Bey, Elly Freeman, Dwayne Mulder, and Jean Ostrem Production by <dot>PS document production services Engineering contributions by David Fedor, Roger Flores, Steve Lemke, Bob Ebert, Ken Krugler, Bruce Thompson, Jesse Donaldson, Tim Wiegman, Gavin Peacock, Ryan Robertson, and Waddah Kudaimi Copyright © 1996 - 2000, Palm, Inc. All rights reserved. This documentation may be printed and copied solely for use in developing products for Palm OS software. In addition, two (2) copies of this documenta- tion may be made for archival and backup purposes. Except for the foregoing, no part of this documenta- tion may be reproduced or transmitted in any form or by any means or used to make any derivative work (such as translation, transformation or adaptation) without express written consent from Palm, Inc. Palm, Inc. reserves the right to revise this documentation and to make changes in content from time to time without obligation on the part of Palm, Inc. to provide notification of such revision or changes. PALM, INC. MAKES NO REPRESENTATIONS OR WARRANTIES THAT THE DOCUMENTATION IS FREE OF ERRORS OR THAT THE DOCUMENTATION IS SUITABLE FOR YOUR USE. THE DOCUMEN- TATION IS PROVIDED ON AN “AS IS” BASIS. PALM, INC. MAKES NO WARRANTIES, TERMS OR CONDITIONS, EXPRESS OR IMPLIED, EITHER IN FACT OR BY OPERATION OF LAW, STATUTORY OR OTHERWISE, INCLUDING WARRANTIES, TERMS, OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND SATISFACTORY QUALITY. TO THE FULL EXTENT ALLOWED BY LAW, PALM, INC. ALSO EXCLUDES FOR ITSELF AND ITS SUP- PLIERS ANY LIABILITY, WHETHER BASED IN CONTRACT OR TORT (INCLUDING NEGLIGENCE), FOR DIRECT, INCIDENTAL, CONSEQUENTIAL, INDIRECT, SPECIAL, OR PUNITIVE DAMAGES OF ANY KIND, OR FOR LOSS OF REVENUE OR PROFITS, LOSS OF BUSINESS, LOSS OF INFORMATION OR DATA, OR OTHER FINANCIAL LOSS ARISING OUT OF OR IN CONNECTION WITH THIS DOCU- MENTATION, EVEN IF PALM, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Palm Computing, Palm OS, Graffiti, HotSync, and Palm Modem are registered trademarks, and Palm III, Palm IIIe, Palm IIIx, Palm V, Palm Vx, Palm VII, Palm, More connected., Simply Palm, the Palm Comput- ing platform logo, Palm III logo, Palm IIIx logo, Palm V logo, and HotSync logo are trademarks of Palm, Inc. or its subsidiaries. All other product and brand names may be trademarks or registered trademarks of their respective owners. IF THIS DOCUMENTATION IS PROVIDED ON A COMPACT DISK, THE OTHER SOFTWARE AND DOCUMENTATION ON THE COMPACT DISK ARE SUBJECT TO THE LICENSE AGREEMENT AC- COMPANYING THE COMPACT DISK. Palm OS SDK Reference Palm, Inc. Document Number 3003-002 5400 Bayfront Plaza March 16, 2000 Santa Clara, CA 95052 USA www.palm.com/devzone Document Number 3003-002 Table of Contents About This Document 49 Palm OS SDK Documentation . 49 What This Volume Contains . 49 Conventions Used in This Guide . 50 Part I: User Interface 1 Application Launch Codes 53 Launch Codes . 55 sysAppLaunchCmdAddRecord . 55 sysAppLaunchCmdAlarmTriggered . 58 sysAppLaunchCmdCountryChange . 59 sysAppLaunchCmdDisplayAlarm . 59 sysAppLaunchCmdExgAskUser . 60 sysAppLaunchCmdExgReceiveData . 62 sysAppLaunchCmdFind . 63 sysAppLaunchCmdGoto . 65 sysAppLaunchCmdGoToURL . 66 sysAppLaunchCmdInitDatabase . 66 sysAppLaunchCmdLookup . 67 sysAppLaunchCmdNotify . 68 sysAppLaunchCmdOpenDB. 68 sysAppLaunchCmdPanelCalledFromApp . 69 sysAppLaunchCmdReturnFromPanel. 69 sysAppLaunchCmdSaveData . 70 sysAppLaunchCmdSyncNotify . 70 sysAppLaunchCmdSystemLock . 71 sysAppLaunchCmdSystemReset . 71 sysAppLaunchCmdTimeChange . 72 sysAppLaunchCmdURLParams . 72 Launch Flags. 73 Palm OS SDK Reference 3 2 Palm OS Resources 75 System Resources. 75 The ‘code’ #1 Resource . 75 The ‘code’ #0 and ‘data’ #0 Resources . 76 The ‘pref’ #0 Resource . 76 Resource Types . 77 Catalog Resources . 77 Project Resources. 78 Alert Resource . 79 Button Resource . 81 Check Box Resource. 83 Field Resource . 84 Form Resource . 86 Form Bitmap Resource . 89 Gadget Resource . 90 Graffiti Shift Indicator Resource . 91 Label Resource . 91 List Resource. 92 Menus and Menu Bars . 94 Popup Trigger Resource . 96 Push Button Resource . 97 Repeating Button Resource. 99 Scroll Bar Resource . 100 Selector Trigger Resource . 101 String Resource. 103 Table Resource . 103 3 Palm OS Events 105 Event Data Structures . 106 eventsEnum . 106 EventType. 107 EventPtr . 109 Event Reference . 109 appStopEvent . 109 ctlEnterEvent . 109 4 Palm OS SDK Reference ctlExitEvent . 110 ctlRepeatEvent. 110 ctlSelectEvent . 111 daySelectEvent. 112 fldChangedEvent . 113 fldEnterEvent . 113 fldHeightChangedEvent . 113 frmCloseEvent . 114 frmGadgetEnterEvent . 115 frmGadgetMiscEvent . 115 frmGotoEvent . 116 frmLoadEvent . 117 frmOpenEvent . 117 frmSaveEvent . 118 frmTitleEnterEvent . 118 frmTitleSelectEvent . 118 frmUpdateEvent . 119 inetSockReadyEvent . 120 inetSockStatusChangeEvent . 120 keyDownEvent . 121 lstEnterEvent . 122 lstExitEvent . 123 lstSelectEvent . 123 menuCloseEvent . 124 menuCmdBarOpenEvent . 124 menuEvent . 124 menuOpenEvent . 125 nilEvent. 126 penDownEvent . 126 penMoveEvent. 127 penUpEvent . 127 popSelectEvent . 128 sclEnterEvent . 129 sclExitEvent . 129 sclRepeatEvent. 130 tblEnterEvent . 131 Palm OS SDK Reference 5 tblExitEvent . 131 tblSelectEvent . 132 winEnterEvent . 133 winExitEvent . 133 4 Categories 135 Category Data Structures . 135 AppInfoType . 135 Category Constants . 136 Category Functions . 137 CategoryCreateList . 137 CategoryCreateListV10 . 139 CategoryEdit . 139 CategoryEditV20 . 140 CategoryEditV10 . 141 CategoryFind . 142 CategoryFreeList . 142 CategoryFreeListV10 . 143 CategoryGetName . 144 CategoryGetNext. 144 CategoryInitialize . 145 CategorySelect . 146 CategorySelectV10 . 147 CategorySetName . 148 CategorySetTriggerLabel . 149 CategoryTruncateName . 149 5 Clipboard 151 Clipboard Data Structures . 151 ClipboardFormatType . 151 Clipboard Functions . 152 ClipboardAddItem . 152 ClipboardAppendItem . 153 ClipboardGetItem . 154 6 Palm OS SDK Reference 6 Controls 155 Control Data Structures . 155 ButtonFrameType . 155 ControlAttrType . 156 ControlPtr. 157 ControlStyleType. 157 ControlType . 159 GraphicControlType . 160 SliderControlType . 162 Control Resources . 164 Control Functions. 165 CtlDrawControl . 165 CtlEnabled . 165 CtlEraseControl . 166 CtlGetLabel . 166 CtlGetSliderValues . 167 CtlGetValue . 168 CtlHandleEvent . 168 CtlHideControl . 169 CtlHitControl . 170 CtlNewControl . 170 CtlNewGraphicControl . 172 CtlNewSliderControl . 174 CtlSetEnabled . ..