Motif 2.1—Programmer's Reference Desktop Product Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Motif 2.1—Programmer’s Reference Desktop Product Documentation The Open Group Copyright © The Open Group, 1997. All Rights Reserved The information contained within this document is subject to change without notice. This documentation and the software to which it relates are derived in part from copyrighted materials supplied by Digital Equipment Corporation, Hewlett-Packard Company, International Business Machines, Massachusetts Institute of Technology, Microsoft Corporation, Sun Microsystems Inc., and The Santa Cruz Operation Inc. THE OPEN GROUP MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. The Open Group shall not be liable for errors contained herein, or for any direct or indirect, incidental, special or consequential damages in connection with the furnishing, performance, or use of this material. Desktop Product Documentation: Motif 2.1—Programmer’s Reference, Volume 1 ISBN 1-85912-119-5 Document Number M214A Motif 2.1—Programmer’s Reference, Volume 2 ISBN 1-85912-124-1 Document Number M214B Motif 2.1—Programmer’s Reference, Volume 3 ISBN 1-85912-164-0 Document Number M214C Published in the U.K. by The Open Group, 1997 Any comments relating to the material contained in this document may be submitted to: The Open Group Apex Plaza Forbury Road Reading Berkshire, RG1 1AX United Kingdom or by Electronic Mail to: [email protected] OTHER NOTICES THIS DOCUMENT AND THE SOFTWARE DESCRIBED HEREIN ARE FURNISHED UNDER A LICENSE, AND MAY BE USED AND COPIED ONLY IN ACCORDANCE WITH THE TERMS OF SUCH LICENSE AND WITH THE INCLUSION OF THE ABOVE COPYRIGHT NOTICE. TITLE TO AND OWNERSHIP OF THE DOCUMENT AND SOFTWARE REMAIN WITH THE OPEN GROUP OR ITS LICENSORS. Certain portions of CDE known as "PBMPlus" are copyrighted © 1989, 1991 by Jef Poskanzer. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appears in all copies and that both the copyright notice and this permission notice appears in supporting documentation. This software is provided "as is" without express or implied warranty. The code and documentation for the DtComboBox and DtSpinBox widgets were contributed by Interleaf, Inc. Copyright © 1993, Interleaf, Inc. FOR U.S. GOVERNMENT CUSTOMERS REGARDING THIS DOCUMENTATION AND THE ASSOCIATED SOFTWARE These notices shall be marked on any reproduction of this data, in whole or in part. NOTICE:Notwithstanding any other lease or license that may pertain to, or accompany the delivery of, this computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in Section 52.227-19 of the FARS Computer Software-Restricted Rights clause. RESTRICTED RIGHTS NOTICE:Use, duplication, or disclosure by the Government is subject to the restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227-7013. RESTRICTED RIGHTS LEGEND:Use, duplication or disclosure by the Government is subject to restrictions as set forth in paragraph (b)(3)(B) of the rights in Technical Data and Computer Software clause in DAR 7-104.9(a). This computer software is submitted with "restricted rights." Use, duplication or disclosure is subject to the restrictions as set forth in NASA FAR SUP 18-52.227-79 (April 1985) "Commercial Computer Software-Restricted Rights (April 1985)." If the contract contains the Clause at 18-52.227-74 "Rights in Data General" then the "Alternate III" clause applies. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract. Unpublished - All rights reserved under the Copyright Laws of the United States. This notice shall be marked on any reproduction of this data, in whole or in part. Contents Preface .................... xvii The Open Group ............ xvii The Development of Product Standards ....... xviii Open Group Publications .......... xix Versions and Issues of Specifications ....... xxi Corrigenda .............. xxi Ordering Information ........... xxi This Book .............. xxii Audience .............. xxii Applicability ............. xxii Purpose ............... xxii Organization ............. xxii Reference Page Format ........ xxiii Related Documents ............ xxiv Typographic and Keying Conventions ....... xxv DocBook SGML Conventions ....... xxvi Terminology Conventions ........ xxvi Keyboard Conventions ......... xxvi Mouse Conventions ......... xxvii Problem Reporting ............ xxvii Trademarks .............. xxvii Chapter 1. Programs ................ 1 mwm ............. 2 uil .............. 37 xmbind ............ 39 i Motif 2.1—Programmer’s Reference Chapter 2. Xt Widget Classes .............. 41 ApplicationShell .......... 42 Composite ............ 47 Constraint ............ 51 Core ............. 54 Object ............. 59 OverrideShell ........... 61 RectObj ............ 64 Shell ............. 67 TopLevelShell ........... 71 TransientShell ........... 76 VendorShell ........... 81 WMShell ............ 94 Chapter 3. Xm Widget Classes .............. 103 XmArrowButton .......... 104 XmArrowButtonGadget ........ 111 XmBulletinBoard .......... 117 XmCascadeButton .......... 128 XmCascadeButtonGadget ........ 139 XmComboBox........... 147 XmCommand ........... 161 XmContainer ........... 171 XmDialogShell .......... 213 XmDisplay ........... 219 XmDragContext .......... 230 XmDragIcon ........... 252 XmDrawingArea .......... 257 XmDrawnButton .......... 268 XmDropTransfer .......... 277 XmFileSelectionBox ......... 281 XmForm ............ 303 XmFrame ............ 319 XmGadget ............ 325 XmIconGadget........... 333 XmLabel ............ 340 XmLabelGadget .......... 356 XmList ............ 371 XmMainWindow .......... 406 XmManager ........... 413 XmMenuShell ........... 428 XmMessageBox .......... 434 XmNotebook ........... 444 ii Contents XmPanedWindow .......... 460 XmPrimitive ........... 470 XmPushButton........... 486 XmPushButtonGadget ......... 498 XmRendition ........... 508 XmRowColumn .......... 512 XmScale ............ 540 XmScreen ............ 558 XmScrollBar ........... 567 XmScrolledWindow ......... 583 XmSelectionBox .......... 595 XmSeparator ........... 608 XmSeparatorGadget ......... 613 XmText ............ 618 XmTextField ........... 673 XmToggleButton .......... 709 XmToggleButtonGadget ........ 725 Chapter 4. Translations................ 739 VirtualBindings .......... 740 Chapter 5. Xm Data Types ............... 747 XmDirection ........... 748 XmFontList ........... 751 XmParseMapping .......... 754 XmParseTable ........... 759 XmRenderTable .......... 760 XmString ............ 763 XmStringDirection.......... 766 XmStringTable........... 767 XmTab ............ 768 XmTabList............ 769 XmTextPosition .......... 771 Chapter 6. Xm Functions ............... 773 XmActivateProtocol ......... 774 XmActivateWMProtocol ........ 776 XmAddProtocolCallback ........ 777 XmAddProtocols .......... 779 XmAddTabGroup .......... 780 XmAddToPostFromList ........ 781 XmAddWMProtocolCallback ....... 783 XmAddWMProtocols ......... 784 iii Motif 2.1—Programmer’s Reference XmCascadeButtonGadgetHighlight ...... 785 XmCascadeButtonHighlight ....... 786 XmChangeColor .......... 787 XmClipboardCancelCopy ........ 788 XmClipboardCopy .......... 790 XmClipboardCopyByName ....... 793 XmClipboardEndCopy ......... 795 XmClipboardEndRetrieve ........ 797 XmClipboardInquireCount ........ 799 XmClipboardInquireFormat ....... 801 XmClipboardInquireLength ....... 803 XmClipboardInquirePendingItems ...... 805 XmClipboardLock .......... 807 XmClipboardRegisterFormat ....... 809 XmClipboardRetrieve ......... 811 XmClipboardStartCopy ........ 814 XmClipboardStartRetrieve ........ 817 XmClipboardUndoCopy ........ 819 XmClipboardUnlock ......... 821 XmClipboardWithdrawFormat ....... 823 XmComboBoxAddItem ........ 825 XmComboBoxDeletePos ........ 827 XmComboBoxSelectItem ........ 828 XmComboBoxSetItem ......... 829 XmComboBoxUpdate ......... 830 XmCommandAppendValue........ 831 XmCommandError.......... 832 XmCommandGetChild ......... 833 XmCommandSetValue ......... 835 XmContainerCopy .......... 836 XmContainerCopyLink......... 837 XmContainerCut .......... 839 XmContainerGetItemChildren ....... 841 XmContainerPaste .......... 843 XmContainerPasteLink......... 844 XmContainerRelayout ......... 845 XmContainerReorder ......... 846 XmConvertStringToUnits ........ 847 XmConvertUnits .......... 850 XmCreateArrowButton......... 853 XmCreateArrowButtonGadget ....... 854 XmCreateBulletinBoard ........ 855 XmCreateBulletinBoardDialog ....... 856 XmCreateCascadeButton ........ 858 iv Contents XmCreateCascadeButtonGadget ...... 860 XmCreateComboBox ......... 862 XmCreateCommand ......... 863 XmCreateContainer ......... 864 XmCreateDialogShell ......... 865 XmCreateDragIcon ......... 866 XmCreateDrawingArea ........ 868 XmCreateDrawnButton ........ 869 XmCreateDropDownComboBox ...... 870 XmCreateDropDownList ........ 872 XmCreateErrorDialog ......... 873 XmCreateFileSelectionBox........ 875 XmCreateFileSelectionDialog ....... 877 XmCreateForm .......... 879 XmCreateFormDialog ......... 880 XmCreateFrame .......... 882 XmCreateIconGadget ......... 883 XmCreateInformationDialog ....... 884 XmCreateLabel .......... 886 XmCreateLabelGadget ......... 887 XmCreateList ........... 888 XmCreateMainWindow ........ 889 XmCreateMenuBar ........