XView Reference Manual Volume Seven XView Reference Manual By Dan Heller Updated for XView Version 3.2 by Thomas Van Raalte O’Reilly & Associates, Inc. XView Programming Manual by Dan Heller Updated for XView Version 3.2 by Thomas Van Raalte Copyright © 1990-1991 O’Reilly & Associates, Inc. All rights reserved. Printed in the United States of America. X Series Editor: Tim O’Reilly Editor: Dale Dougherty Printing History: January 1990: First edition. April 1990: Minor corrections. July 1990: Second edition. Updated for XView Version 2. October 1990: Minor corrections. September 1991: Third edition. Updated for XView Version 3. March 1992: Minor corrections. August 1992: Minor corrections. August 1993: Minor additions. Updated for XView Version 3.2. Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this book, and O’Reilly & Associates, Inc. was aware of a trademark claim, the designations have been printed in caps or initial caps. While every precaution has been taken in the preparation of this book, the publisher assumes no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein. This book is printed on acid-free paper with 50% recycled content, 10-15% post-consumer waste. O’Reilly & Associates is committed to using paper with the highest recycled content available consistent with high quality. Volume 7: ISBN 0–937175–87-0 Volume 7B: XView Reference Manual Table of Contents Page Preface xi How to Use This Manual xi Font Conventions Used in This Manual xii Related Documents xiii Requests for Comments xiv Acknowledgements xiv Chapter 1 XView Package Summary 3 1.1 XView and OPEN LOOK 3 1.2 XView Packages 4 1.2.1 Object Handles 5 1.2.2 Attribute-based Functions 6 1.2.3 Creating and Manipulating Objects 6 1.3 The CANVAS Package 7 1.4 The CMS Package 8 1.5 The CURSOR Package 8 1.6 The DRAGDROP and DROP_SITE_ITEM Packages 9 1.7 The FONT Package 9 1.8 The FRAME Package 10 1.9 The FULLSCREEN Package 11 1.10 The ICON Package 12 1.11 The MENU and MENUITEM Packages 12 1.11.1 Menu Types 13 1.11.2 Menu Items 13 1.12 The NOTICE Package 14 1.13 The PANEL Package 15 1.13.1 Panel Items 15 1.13.2 Scrollable Panels 23 1.14 The SCREEN Object 23 1.15 The SCROLLBAR Package 24 1.16 The SELECTION Package 24 1.17 The SERVER Package 24 1.18 The TEXTSW Package 25 1.19 The TTYSW Package 25 1.20 The Notifier 26 1.20.1 Mainline Input Handling 26 1.20.2 Event-driven Input Handling 26 1.20.3 Functions of the Notifier 27 1.20.4 How the Notifier Works 27 Chapter 2 XView Attributes 31 Chapter 3 Procedures and Macros 175 Chapter 4 Data Types 221 Chapter 5 Event Codes 231 Chapter 6 Command-line Arguments and XView Resources 239 6.1 Command-line Options with Resources 240 6.2 Additional Resources 250 Appendix A Selection Compatibility Attributes 275 Appendix B Selection Compatibility Procedures and Macros 281 Appendix C Textsw Action Attributes 289 Index 291 Figures Page 1-1 XView class hierarchy 5 1-2 Panel item created with PANEL_BUTTON package 16 1-3 Panel button with an attached menu 16 1-4 Panel item created with the PANEL_ABBREV_MENU_BUTTON package 17 1-5 Panel item from the PANEL_CHOICE package 17 1-6 Panel item from the PANEL_CHECK_BOX package 17 1-7 Panel item created with PANEL_TOGGLE macro 18 1-8 Panel item created with PANEL_CHOICE_STACK macro 18 1-9 Panel drop target items 19 1-10 Panel item created with the PANEL_GAUGE package 19 1-11 Panel list item created with the PANEL_LIST package 20 1-12 Panel item created with PANEL_MESSAGE package 20 1-13 Another panel item created with PANEL_MESSAGE package 21 1-14 Panel item created with the PANEL_MULTILINE_TEXT package 21 1-15 Panel item created with the PANEL_NUMERIC_TEXT package 22 1-16 Panel item created with the PANEL_SLIDER package 22 1-17 Panel item created with the PANEL_TEXT package 23 Tables Page 1-1 Generic Functions 6 1-2 XView Packages 6 5-1 Event Codes 231 5-2 Mouseless Event Codes 234 This page intentionally left blank to preserve original page counts. This page intentionally left blank to preserve original page counts. Preface Preface This manual describes the XView attributes, callbacks, procedures, macros, data structures, as well as additional reference material. XView (X Window-System-based Visual/Integrated Environment for Workstations) is a user-interface toolkit to support interactive, graphics- based applications running under the X Window System. This toolkit, developed by Sun Microsystems, Inc., is derived from earlier toolkits for the SunView windowing system. With over 2000 SunView applications in the workstation market, there are many program- mers already familiar with SunView application programmer's interface (API). XView is based upon Xlib, the lowest level of the X Window System available to the pro- grammer. While developing XView user interfaces does not require Xlib programming expe- rience, there are good reasons for learning more about Xlib, especially if your application renders graphics. How to Use This Manual The XView Reference Manual includes reference material for each of the XView attributes and procedures, information about XView resources, and data structures. Within each sec- tion, reference pages are organized alphabetically. This book is designed to be used with the XView Programming Manual. The XView Pro- gramming Manual provides an explanation of XView, including tutorial material and numer- ous programming examples. To get the most out of the XView Programming Manual, you will need the exact arguments for the attributes and the calling sequence for the callbacks and procedures that this reference manual provides. The following paragraphs brie¯y describe the contents of this book: Section 1, XView Package Summary, provides an introduction to XView and provides a sum- mary of each of the XView packages. Section 2, XView Attributes, provides alphabetically arranged descriptions of all attributes, and the callback procedures that are supplied by the application programmer. Section 3, Procedures and Macros, provides alphabetically arranged descriptions of all the XView procedures and macros. Preface xi Section 4, Data Types, lists the data types de®ned by XView. Section 5, Event Codes, lists the event codes in numerical order by value. Section 6, Command-line Arguments and XView Resources, lists the XView options that can be set using command-line options. This section also lists the resources that XView uses to de®ne certain default values when an application is initialized. Appendix A, Selection Compatibility Attributes, provides the attributes for the old selection mechanism. A new selection package has been added in XView Version 3. The new selec- tion package supports the standard XView API. The old selection mechanism is still sup- ported in XView Version 3. Appendix B, Selection Compatibility Procedures and Macros, provides the procedures and macros for the old selection mechanism. A new selection package has been added in XView Version 3. The new selection package supports the standard XView API. The old selection mechanism is still supported in XView Version 3. Appendix C, Textsw Action Attributes, provides the ACTION_* attributes that are available for use with a client-supplied notify procedure. These attributes are not standard attributes and cannot be used with xv_create(), xv_get(), or xv_set(). Font Conventions Used in This Manual Italic is used for: · UNIX pathnames, ®lenames, program names, user command names, and options for user commands. · New terms where they are introduced. Typewriter Font is used for: · Anything that would be typed verbatim into code, such as examples of source code and text on the screen. · XView packages.* · The contents of include ®les, such as structure types, structure members, sym- bols (de®ned constants and bit ¯ags), and macros. · XView and Xlib functions. · Names of subroutines of the example programs. Italic Typewriter Font is used for: · Arguments to XView functions, since they could be typed in code as shown but are arbitrary. *When referring to all members of a particular package, such as CANVAS, the notation CANVAS_* will be used. This should not be interpreted as a C-language pointer construct. xii XView Reference Manual Helvetica Italics are used for: · Titles of examples, ®gures, and tables. Boldface is used for: Preface · Sections and headings. Related Documents The C Programming Language by B. W. Kernighan and D. M. Ritchie. The following documents are included on the X11 source tape: OPEN LOOK Graphical User Interface Functional Speci®cation OPEN LOOK Graphical User Interface Style Guide The following books in the X Window System series from O'Reilly & Associates, Inc. are currently available: Volume Zero Ð X Protocol Reference Manual Volume One Ð Xlib Programming Manual Volume Two Ð Xlib Reference Manual Volume Three Ð X Window System User's Guide Volume Four Ð X Toolkit Intrinsics Programming Manual Volume Five Ð X Toolkit Intrinsics Reference Manual Volume Six A Ð Motif Programming Manual Volume Six B Ð Motif Reference Manual Volume Seven Ð XView Programming Manual Volume Eight Ð X Administrator's Guide Quick Reference Ð The X Window System in a Nutshell PHIGS Programming Manual PHIGS Reference Manual Pexlib Programming Manual Pexlib Reference Manual Preface xiii Requests for Comments Please write to tell us about any ¯aws you ®nd in this manual or how you think it could be improved, to help us provide you with the best documentation possible. Our U.S. mail address, phone numbers, and e-mail addresses are as follows: O'Reilly & Associates, Inc.