From: Peter Howkins Date: Fri, 15 Jun 2012 14:58:42 +0000 (+0100) Subject: Import of the files from Motif 2.1.30 release that are needed to build CDE X-Git-Tag: 2.2.0a~26^2~26 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=bdd889c1415f903fe98b330daf419d057e8edba8;p=oweals%2Fcde.git Import of the files from Motif 2.1.30 release that are needed to build CDE man pages. --- diff --git a/cde/.gitignore b/cde/.gitignore index 74880dc4..aa713e20 100644 --- a/cde/.gitignore +++ b/cde/.gitignore @@ -13,7 +13,7 @@ DONE # imports of of headers -imports +imports/x11 # exports of libraries/headers exports diff --git a/cde/imports/motif/doc/C/guides/common/BOOKDEFS.sgm b/cde/imports/motif/doc/C/guides/common/BOOKDEFS.sgm new file mode 100644 index 00000000..64c6a17b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/common/BOOKDEFS.sgm @@ -0,0 +1,23 @@ + + + + + + + + + +Motif Patch Kit Notes"> +Motif Porting Guide"> +Motif Programmer's Guide"> +Motif Programmer's Reference"> +Motif Release Notes"> +Motif Style Guide"> +Motif Technical Bulletins"> +Motif Test Suite User's Guide"> +Motif User's Guide"> +Motif Widget Meta-Language Facility"> +Motif Widget Writer's Guide"> + +Application Environment Specification — User Environment Volume"> +AES/UE Validation Suite User's Guide"> diff --git a/cde/imports/motif/doc/C/guides/common/ManLinks.sgm b/cde/imports/motif/doc/C/guides/common/ManLinks.sgm new file mode 100644 index 00000000..8bfa92af --- /dev/null +++ b/cde/imports/motif/doc/C/guides/common/ManLinks.sgm @@ -0,0 +1,645 @@ + + + + + + + + + +mwm(1)"> +uil(1)"> +xmbind(1)"> +ApplicationShell(3)"> +Composite(3)"> +Constraint(3)"> +Core(3)"> +Object(3)"> +OverrideShell(3)"> +RectObj(3)"> +Shell(3)"> +TopLevelShell(3)"> +TransientShell(3)"> +VendorShell(3)"> +WMShell(3)"> +XmArrowButton(3)"> +XmArrowButtonGadget(3)"> +XmBulletinBoard(3)"> +XmCascadeButton(3)"> +XmCascadeButtonGadget(3)"> +XmComboBox(3)"> +XmCommand(3)"> +XmContainer(3)"> +XmDialogShell(3)"> +XmDisplay(3)"> +XmDragContext(3)"> +XmDragIcon(3)"> +XmDrawingArea(3)"> +XmDrawnButton(3)"> +XmDropTransfer(3)"> +XmFileSelectionBox(3)"> +XmForm(3)"> +XmFrame(3)"> +XmGadget(3)"> +XmIconGadget(3)"> +XmLabel(3)"> +XmLabelGadget(3)"> +XmList(3)"> +XmMainWindow(3)"> +XmManager(3)"> +XmMenuShell(3)"> +XmMessageBox(3)"> +XmNotebook(3)"> +XmPanedWindow(3)"> +XmPrimitive(3)"> +XmPushButton(3)"> +XmPushButtonGadget(3)"> +XmRendition(3)"> +XmRowColumn(3)"> +XmScale(3)"> +XmScreen(3)"> +XmScrollBar(3)"> +XmScrolledWindow(3)"> +XmSelectionBox(3)"> +XmSeparator(3)"> +XmSeparatorGadget(3)"> +XmText(3)"> +XmTextField(3)"> +XmToggleButton(3)"> +XmToggleButtonGadget(3)"> +VirtualBindings(3)"> +XmDirection(3)"> +XmFontList(3)"> +XmParseMapping(3)"> +XmParseTable(3)"> +XmRenderTable(3)"> +XmString(3)"> +XmStringDirection(3)"> +XmStringTable(3)"> +XmTab(3)"> +XmTabList(3)"> +XmTextPosition(3)"> +XmActivateProtocol(3)"> +XmActivateWMProtocol(3)"> +XmAddProtocolCallback(3)"> +XmAddProtocols(3)"> +XmAddTabGroup(3)"> +XmAddToPostFromList(3)"> +XmAddWMProtocolCallback(3)"> +XmAddWMProtocols(3)"> +XmCascadeButtonGadgetHighlight(3)"> +XmCascadeButtonHighlight(3)"> +XmChangeColor(3)"> +XmClipboardCancelCopy(3)"> +XmClipboardCopy(3)"> +XmClipboardCopyByName(3)"> +XmClipboardEndCopy(3)"> +XmClipboardEndRetrieve(3)"> +XmClipboardInquireCount(3)"> +XmClipboardInquireFormat(3)"> +XmClipboardInquireLength(3)"> +XmClipboardInquirePendingItems(3)"> +XmClipboardLock(3)"> +XmClipboardRegisterFormat(3)"> +XmClipboardRetrieve(3)"> +XmClipboardStartCopy(3)"> +XmClipboardStartRetrieve(3)"> +XmClipboardUndoCopy(3)"> +XmClipboardUnlock(3)"> +XmClipboardWithdrawFormat(3)"> +XmComboBoxAddItem(3)"> +XmComboBoxDeletePos(3)"> +XmComboBoxSelectItem(3)"> +XmComboBoxSetItem(3)"> +XmComboBoxUpdate(3)"> +XmCommandAppendValue(3)"> +XmCommandError(3)"> +XmCommandGetChild(3)"> +XmCommandSetValue(3)"> +XmContainerCopy(3)"> +XmContainerCopyLink(3)"> +XmContainerCut(3)"> +XmContainerGetItemChildren(3)"> +XmContainerPaste(3)"> +XmContainerPasteLink(3)"> +XmContainerRelayout(3)"> +XmContainerReorder(3)"> +XmConvertStringToUnits(3)"> +XmConvertUnits(3)"> +XmCreateArrowButton(3)"> +XmCreateArrowButtonGadget(3)"> +XmCreateBulletinBoard(3)"> +XmCreateBulletinBoardDialog(3)"> +XmCreateCascadeButton(3)"> +XmCreateCascadeButtonGadget(3)"> +XmCreateComboBox(3)"> +XmCreateCommand(3)"> +XmCreateCommandDialog(3)"> +XmCreateContainer(3)"> +XmCreateDialogShell(3)"> +XmCreateDragIcon(3)"> +XmCreateDrawingArea(3)"> +XmCreateDrawnButton(3)"> +XmCreateDropDownComboBox(3)"> +XmCreateDropDownList(3)"> +XmCreateErrorDialog(3)"> +XmCreateFileSelectionBox(3)"> +XmCreateFileSelectionDialog(3)"> +XmCreateForm(3)"> +XmCreateFormDialog(3)"> +XmCreateFrame(3)"> +XmCreateIconGadget(3)"> +XmCreateInformationDialog(3)"> +XmCreateLabel(3)"> +XmCreateLabelGadget(3)"> +XmCreateList(3)"> +XmCreateMainWindow(3)"> +XmCreateMenuBar(3)"> +XmCreateMenuShell(3)"> +XmCreateMessageBox(3)"> +XmCreateMessageDialog(3)"> +XmCreateNotebook(3)"> +XmCreateOptionMenu(3)"> +XmCreatePanedWindow(3)"> +XmCreatePopupMenu(3)"> +XmCreatePromptDialog(3)"> +XmCreatePulldownMenu(3)"> +XmCreatePushButton(3)"> +XmCreatePushButtonGadget(3)"> +XmCreateQuestionDialog(3)"> +XmCreateRadioBox(3)"> +XmCreateRowColumn(3)"> +XmCreateScale(3)"> +XmCreateScrollBar(3)"> +XmCreateScrolledList(3)"> +XmCreateScrolledText(3)"> +XmCreateScrolledWindow(3)"> +XmCreateSelectionBox(3)"> +XmCreateSelectionDialog(3)"> +XmCreateSeparator(3)"> +XmCreateSeparatorGadget(3)"> +XmCreateSimpleCheckBox(3)"> +XmCreateSimpleMenuBar(3)"> +XmCreateSimpleOptionMenu(3)"> +XmCreateSimplePopupMenu(3)"> +XmCreateSimplePulldownMenu(3)"> +XmCreateSimpleRadioBox(3)"> +XmCreateSimpleSpinBox(3)"> +XmCreateSpinBox(3)"> +XmCreateTemplateDialog(3)"> +XmCreateText(3)"> +XmCreateTextField(3)"> +XmCreateToggleButton(3)"> +XmCreateToggleButtonGadget(3)"> +XmCreateWarningDialog(3)"> +XmCreateWorkArea(3)"> +XmCreateWorkingDialog(3)"> +XmCvtByteStreamToXmString(3)"> +XmCvtCTToXmString(3)"> +XmCvtStringToUnitType(3)"> +XmCvtTextPropertyToXmStringTable(3)"> +XmCvtXmStringTableToTextProperty(3)"> +XmCvtXmStringToByteStream(3)"> +XmCvtXmStringToCT(3)"> +XmDeactivateProtocol(3)"> +XmDeactivateWMProtocol(3)"> +XmDestroyPixmap(3)"> +XmDirectionMatch(3)"> +XmDirectionMatchPartial(3)"> +XmDirectionToStringDirection(3)"> +XmDragCancel(3)"> +XmDragStart(3)"> +XmDropSite(3)"> +XmDropSiteConfigureStackingOrder(3)"> +XmDropSiteEndUpdate(3)"> +XmDropSiteQueryStackingOrder(3)"> +XmDropSiteRegister(3)"> +XmDropSiteRegistered(3)"> +XmDropSiteRetrieve(3)"> +XmDropSiteStartUpdate(3)"> +XmDropSiteUnregister(3)"> +XmDropSiteUpdate(3)"> +XmDropTransferAdd(3)"> +XmDropTransferStart(3)"> +XmFileSelectionBoxGetChild(3)"> +XmFileSelectionDoSearch(3)"> +XmFontListAdd(3)"> +XmFontListAppendEntry(3)"> +XmFontListCopy(3)"> +XmFontListCreate(3)"> +XmFontListEntryCreate(3)"> +XmFontListEntryFree(3)"> +XmFontListEntryGetFont(3)"> +XmFontListEntryGetTag(3)"> +XmFontListEntryLoad(3)"> +XmFontListFree(3)"> +XmFontListFreeFontContext(3)"> +XmFontListGetNextFont(3)"> +XmFontListInitFontContext(3)"> +XmFontListNextEntry(3)"> +XmFontListRemoveEntry(3)"> +XmGetAtomName(3)"> +XmGetColorCalculation(3)"> +XmGetColors(3)"> +XmGetDestination(3)"> +XmGetDragContext(3)"> +XmGetFocusWidget(3)"> +XmGetMenuCursor(3)"> +XmGetPixmap(3)"> +XmGetPixmapByDepth(3)"> +XmGetPostedFromWidget(3)"> +XmGetSecondaryResourceData(3)"> +XmGetTabGroup(3)"> +XmGetTearOffControl(3)"> +XmGetVisibility(3)"> +XmGetXmDisplay(3)"> +XmGetXmScreen(3)"> +XmImCloseXIM(3)"> +XmImFreeXIC(3)"> +XmImGetXIC(3)"> +XmImGetXIM(3)"> +XmImMbLookupString(3)"> +XmImMbResetIC(3)"> +XmImRegister(3)"> +XmImSetFocusValues(3)"> +XmImSetValues(3)"> +XmImSetXIC(3)"> +XmImUnregister(3)"> +XmImUnsetFocus(3)"> +XmImVaSetFocusValues(3)"> +XmImVaSetValues(3)"> +XmInstallImage(3)"> +XmInternAtom(3)"> +XmIsMotifWMRunning(3)"> +XmIsTraversable(3)"> +XmListAddItem(3)"> +XmListAddItemUnselected(3)"> +XmListAddItems(3)"> +XmListAddItemsUnselected(3)"> +XmListDeleteAllItems(3)"> +XmListDeleteItem(3)"> +XmListDeleteItems(3)"> +XmListDeleteItemsPos(3)"> +XmListDeletePos(3)"> +XmListDeletePositions(3)"> +XmListDeselectAllItems(3)"> +XmListDeselectItem(3)"> +XmListDeselectPos(3)"> +XmListGetKbdItemPos(3)"> +XmListGetMatchPos(3)"> +XmListGetSelectedPos(3)"> +XmListItemExists(3)"> +XmListItemPos(3)"> +XmListPosSelected(3)"> +XmListPosToBounds(3)"> +XmListReplaceItems(3)"> +XmListReplaceItemsPos(3)"> +XmListReplaceItemsPosUnselected(3)"> +XmListReplaceItemsUnselected(3)"> +XmListReplacePositions(3)"> +XmListSelectItem(3)"> +XmListSelectPos(3)"> +XmListSetAddMode(3)"> +XmListSetBottomItem(3)"> +XmListSetBottomPos(3)"> +XmListSetHorizPos(3)"> +XmListSetItem(3)"> +XmListSetKbdItemPos(3)"> +XmListSetPos(3)"> +XmListUpdateSelectedList(3)"> +XmListYToPos(3)"> +XmMainWindowSep1(3)"> +XmMainWindowSep2(3)"> +XmMainWindowSep3(3)"> +XmMainWindowSetAreas(3)"> +XmMapSegmentEncoding(3)"> +XmMenuPosition(3)"> +XmMessageBoxGetChild(3)"> +XmNotebookGetPageInfo(3)"> +XmObjectAtPoint(3)"> +XmOptionButtonGadget(3)"> +XmOptionLabelGadget(3)"> +XmParseMappingCreate(3)"> +XmParseMappingFree(3)"> +XmParseMappingGetValues(3)"> +XmParseMappingSetValues(3)"> +XmParseTableFree(3)"> +XmGetScaledPixmap(3)"> +XmPrintPopupPDM(3)"> +XmPrintSetup(3)"> +XmPrintShell(3)"> +XmPrintToFile(3)"> +XmProcessTraversal(3)"> +XmRedisplayWidget(3)"> +XmRegisterSegmentEncoding(3)"> +XmRemoveFromPostFromList(3)"> +XmRemoveProtocolCallback(3)"> +XmRemoveProtocols(3)"> +XmRemoveTabGroup(3)"> +XmRemoveWMProtocolCallback(3)"> +XmRemoveWMProtocols(3)"> +XmRenderTableAddRenditions(3)"> +XmRenderTableCopy(3)"> +XmRenderTableCvtFromProp(3)"> +XmRenderTableCvtToProp(3)"> +XmRenderTableFree(3)"> +XmRenderTableGetRendition(3)"> +XmRenderTableGetRenditions(3)"> +XmRenderTableGetTags(3)"> +XmRenderTableRemoveRenditions(3)"> +XmRenditionCreate(3)"> +XmRenditionFree(3)"> +XmRenditionRetrieve(3)"> +XmRenditionUpdate(3)"> +XmRepTypeAddReverse(3)"> +XmRepTypeGetId(3)"> +XmRepTypeGetNameList(3)"> +XmRepTypeGetRecord(3)"> +XmRepTypeGetRegistered(3)"> +XmRepTypeInstallTearOffModelConverter(3)"> +XmRepTypeRegister(3)"> +XmRepTypeValidValue(3)"> +XmResolveAllPartOffsets(3)"> +XmResolvePartOffsets(3)"> +XmScaleGetValue(3)"> +XmScaleSetTicks(3)"> +XmScaleSetValue(3)"> +XmScrollBarGetValues(3)"> +XmScrollBarSetValues(3)"> +XmScrollVisible(3)"> +XmScrolledWindowSetAreas(3)"> +XmSelectionBoxGetChild(3)"> +XmSetColorCalculation(3)"> +XmSetFontUnit(3)"> +XmSetFontUnits(3)"> +XmSetMenuCursor(3)"> +XmSetProtocolHooks(3)"> +XmSetWMProtocolHooks(3)"> +XmSpinBox(3)"> +XmSimpleSpinBoxAddItem(3)"> +XmSimpleSpinBoxDeletePos(3)"> +XmSimpleSpinBoxSetItem(3)"> +XmSpinBoxValidatePosition(3)"> +XmSimpleSpinBox(3)"> +XmStringBaseline(3)"> +XmStringByteCompare(3)"> +XmStringByteStreamLength(3)"> +XmStringCompare(3)"> +XmStringComponentCreate(3)"> +XmStringComponentType(3)"> +XmStringConcat(3)"> +XmStringConcatAndFree(3)"> +XmStringCopy(3)"> +XmStringCreate(3)"> +XmStringCreateLocalized(3)"> +XmStringCreateLtoR(3)"> +XmStringCreateSimple(3)"> +XmStringDirectionCreate(3)"> +XmStringDirectionToDirection(3)"> +XmStringDraw(3)"> +XmStringDrawImage(3)"> +XmStringDrawUnderline(3)"> +XmStringEmpty(3)"> +XmStringExtent(3)"> +XmStringFree(3)"> +XmStringFreeContext(3)"> +XmStringGenerate(3)"> +XmStringGetLtoR(3)"> +XmStringGetNextComponent(3)"> +XmStringGetNextSegment(3)"> +XmStringGetNextTriple(3)"> +XmStringHasSubstring(3)"> +XmStringHeight(3)"> +XmStringInitContext(3)"> +XmStringIsVoid(3)"> +XmStringLength(3)"> +XmStringLineCount(3)"> +XmStringNConcat(3)"> +XmStringNCopy(3)"> +XmStringParseText(3)"> +XmStringPeekNextComponent(3)"> +XmStringPeekNextTriple(3)"> +XmStringPutRendition(3)"> +XmStringSegmentCreate(3)"> +XmStringSeparatorCreate(3)"> +XmStringTableParseStringArray(3)"> +XmStringTableProposeTablist(3)"> +XmStringTableToXmString(3)"> +XmStringTableUnparse(3)"> +XmStringToXmStringTable(3)"> +XmStringUnparse(3)"> +XmStringWidth(3)"> +XmTabCreate(3)"> +XmTabFree(3)"> +XmTabGetValues(3)"> +XmTabListCopy(3)"> +XmTabListFree(3)"> +XmTabListGetTab(3)"> +XmTabListInsertTabs(3)"> +XmTabListRemoveTabs(3)"> +XmTabListReplacePositions(3)"> +XmTabListTabCount(3)"> +XmTabSetValue(3)"> +XmTargetsAreCompatible(3)"> +XmTextClearSelection(3)"> +XmTextCopy(3)"> +XmTextCopyLink(3)"> +XmTextCut(3)"> +XmTextDisableRedisplay(3)"> +XmTextEnableRedisplay(3)"> +XmTextFieldClearSelection(3)"> +XmTextFieldCopy(3)"> +XmTextFieldCopyLink(3)"> +XmTextFieldCut(3)"> +XmTextFieldGetBaseline(3)"> +XmTextFieldGetEditable(3)"> +XmTextFieldGetInsertionPosition(3)"> +XmTextFieldGetLastPosition(3)"> +XmTextFieldGetMaxLength(3)"> +XmTextFieldGetSelection(3)"> +XmTextFieldGetSelectionPosition(3)"> +XmTextFieldGetSelectionWcs(3)"> +XmTextFieldGetString(3)"> +XmTextFieldGetStringWcs(3)"> +XmTextFieldGetSubstring(3)"> +XmTextFieldGetSubstringWcs(3)"> +XmTextFieldInsert(3)"> +XmTextFieldInsertWcs(3)"> +XmTextFieldPaste(3)"> +XmTextFieldPasteLink(3)"> +XmTextFieldPosToXY(3)"> +XmTextFieldRemove(3)"> +XmTextFieldReplace(3)"> +XmTextFieldReplaceWcs(3)"> +XmTextFieldSetAddMode(3)"> +XmTextFieldSetEditable(3)"> +XmTextFieldSetHighlight(3)"> +XmTextFieldSetInsertionPosition(3)"> +XmTextFieldSetMaxLength(3)"> +XmTextFieldSetSelection(3)"> +XmTextFieldSetString(3)"> +XmTextFieldSetStringWcs(3)"> +XmTextFieldShowPosition(3)"> +XmTextFieldXYToPos(3)"> +XmTextFindString(3)"> +XmTextFindStringWcs(3)"> +XmTextGetBaseline(3)"> +XmTextGetCenterline(3)"> +XmTextGetEditable(3)"> +XmTextGetInsertionPosition(3)"> +XmTextGetLastPosition(3)"> +XmTextGetMaxLength(3)"> +XmTextGetSelection(3)"> +XmTextGetSelectionPosition(3)"> +XmTextGetSelectionWcs(3)"> +XmTextGetSource(3)"> +XmTextGetString(3)"> +XmTextGetStringWcs(3)"> +XmTextGetSubstring(3)"> +XmTextGetSubstringWcs(3)"> +XmTextGetTopCharacter(3)"> +XmTextInsert(3)"> +XmTextInsertWcs(3)"> +XmTextPaste(3)"> +XmTextPasteLink(3)"> +XmTextPosToXY(3)"> +XmTextRemove(3)"> +XmTextReplace(3)"> +XmTextReplaceWcs(3)"> +XmTextScroll(3)"> +XmTextSetAddMode(3)"> +XmTextSetEditable(3)"> +XmTextSetHighlight(3)"> +XmTextSetInsertionPosition(3)"> +XmTextSetMaxLength(3)"> +XmTextSetSelection(3)"> +XmTextSetSource(3)"> +XmTextSetString(3)"> +XmTextSetStringWcs(3)"> +XmTextSetTopCharacter(3)"> +XmTextShowPosition(3)"> +XmTextXYToPos(3)"> +XmToggleButtonGadgetGetState(3)"> +XmToggleButtonGadgetSetState(3)"> +XmToggleButtonGetState(3)"> +XmToggleButtonSetState(3)"> +XmToggleButtonSetValue(3)"> +XmTrackingEvent(3)"> +XmTrackingLocate(3)"> +XmTransferDone(3)"> +XmTransferSendRequest(3)"> +XmTransferSetParameters(3)"> +XmTransferStartRequest(3)"> +XmTransferValue(3)"> +XmTranslateKey(3)"> +XmUninstallImage(3)"> +XmUpdateDisplay(3)"> +XmVaCreateSimpleCheckBox(3)"> +XmVaCreateSimpleMenuBar(3)"> +XmVaCreateSimpleOptionMenu(3)"> +XmVaCreateSimplePopupMenu(3)"> +XmVaCreateSimplePulldownMenu(3)"> +XmVaCreateSimpleRadioBox(3)"> +XmWidgetGetBaselines(3)"> +XmWidgetGetDisplayRect(3)"> +MrmCloseHierarchy(3)"> +MrmFetchBitmapLiteral(3)"> +MrmFetchColorLiteral(3)"> +MrmFetchIconLiteral(3)"> +MrmFetchLiteral(3)"> +MrmFetchSetValues(3)"> +MrmFetchWidget(3)"> +MrmFetchWidgetOverride(3)"> +MrmInitialize(3)"> +MrmOpenHierarchy(3)"> +MrmOpenHierarchyFromBuffer(3)"> +MrmOpenHierarchyPerDisplay(3)"> +MrmRegisterClass(3)"> +MrmRegisterNames(3)"> +MrmRegisterNamesInHierarchy(3)"> +Uil(3)"> +UilDumpSymbolTable(3)"> +mwmrc(4)"> +Traits(5)"> +UIL(5)"> +WML(5)"> +XmeAddFocusChangeCallback(3)"> +XmeClearBorder(3)"> +XmeClipboardSink(3)"> +XmeClipboardSource(3)"> +XmeGetDesktopColorCells(3)"> +XmeGetColorObjData(3)"> +XmeConfigureObject(3)"> +XmeConvertMerge(3)"> +XmeCreateClassDialog(3)"> +XmeDragSource(3)"> +XmeDrawArrow(3)"> +XmeDrawCircle(3)"> +XmeDrawDiamond(3)"> +XmeDrawHighlight(3)"> +XmeDrawIndicator(3)"> +XmeDrawPolygonShadow(3)"> +XmeDrawSeparator(3)"> +XmeDrawShadows(3)"> +XmeDropSink(3)"> +XmeFocusIsInShell(3)"> +XmeFromHorizontalPixels(3)"> +XmeFromVerticalPixels(3)"> +XmeGetDefaultPixel(3)"> +XmeGetDefaultRenderTable(3)"> +XmeGetDirection(3)"> +XmeGetEncodingAtom(3)"> +XmeGetHomeDirName(3)"> +XmeGetLocalizedString(3)"> +XmeGetNextCharacter(3)"> +XmeGetNullCursor(3)"> +XmeGetPixmapData(3)"> +XmeGetTextualDragIcon(3)"> +XmeMicroSleep(3)"> +XmeNamedSink(3)"> +XmeNamedSource(3)"> +XmeNamesAreEqual(3)"> +XmeNavigChangeManaged(3)"> +XmePrimarySink(3)"> +XmePrimarySource(3)"> +XmeQueryBestCursorSize(3)"> +XmeRedisplayGadgets(3)"> +XmeRemoveFocusChangeCallback(3)"> +XmeRenderTableGetDefaultFont(3)"> +XmeReplyToQueryGeometry(3)"> +XmeResolvePartOffsets(3)"> +XmeSecondarySink(3)"> +XmeSecondarySource(3)"> +XmeSecondaryTransfer(3)"> +XmeSetWMShellTitle(3)"> +XmeStandardConvert(3)"> +XmeStandardTargets(3)"> +XmeToHorizontalPixels(3)"> +XmeToVerticalPixels(3)"> +XmeTraitGet(3)"> +XmeTraitSet(3)"> +XmeTransferAddDoneProc(3)"> +XmeVirtualToActualKeysyms(3)"> +XmeWarning(3)"> +XmQTaccessTextual(3)"> +XmQTactivatable(3)"> +XmQTcareParentVisual(3)"> +XmQTcontainer(3)"> +XmQTcontainerItem(3)"> +XmQTdialogShellSavvy(3)"> +XmQTjoinSide(3)"> +XmQTmenuSavvy(3)"> +XmQTmenuSystem(3)"> +XmQTnavigator(3)"> +XmQTscrollFrame(3)"> +XmQTspecifyRenderTable(3)"> +XmQTtakesDefault(3)"> +XmQTtransfer(3)"> +ExmCommandButton(3)"> +ExmGrid(3)"> +ExmMenuButton(3)"> +ExmPanner(3)"> +ExmSimple(3)"> +ExmString(3)"> +ExmStringTransfer(3)"> +ExmTabButton(3)"> diff --git a/cde/imports/motif/doc/C/guides/man/PR1X/mwm.sgm b/cde/imports/motif/doc/C/guides/man/PR1X/mwm.sgm new file mode 100644 index 00000000..345a0364 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR1X/mwm.sgm @@ -0,0 +1,2349 @@ + + + + + + + + + + +mwm +user cmd + +mwmThe Motif +Window Manager + + +mwm +options + + + +DESCRIPTION +The mwm window manager provides +functions that facilitate control (by the user and the programmer) +of elements of window state such as placement, size, icon/normal display, +and input-focus ownership. +The stand-alone window manager is not an integral part +of CDE and does not support communication with other components in the CDE +environment, such as the Style Manager and the Session Manager. + + +Options + +−display display + +This option specifies the display to use; see X(1). + + + +−xrm resourcestring + +This option specifies a resource string to use. + + +−multiscreen + +This option causes mwm to manage all screens on +the display. Since mwm does this by default, this option +is of limited use. See the multiScreen resource for information +on managing a single screen. + + +−name name + +This option causes mwm to retrieve its resources +using the specified name, as in name*resource. + + +−screens name [name [...]] + +This option specifies the resource names to use for the screens managed +by mwm. If mwm is managing a single +screen, only the first name in the list is used. If mwm +is managing multiple screens, the names are assigned to the screens in order, +starting with screen 0. Screen 0 gets the first name, screen 1 the second +name, and so on. + + + + + +Appearance +The following sections describe the basic default behaviors of windows, +icons, the icon box, input focus, and window stacking. The appearance and +behavior of the window manager can be altered by changing the configuration +of specific resources. Resources are defined under the heading "X DEFAULTS." + + + +Screens +By default, mwm manages only the single screen specified +by the −display option or the DISPLAY environment variable (by default, screen 0). If the −multiscreen option is specified or if the multiScreen resource is True, mwm tries to manage all +the screens on the display. +When mwm is managing multiple screens, the −screens option can be used to give each screen a unique +resource name. The names are separated by blanks, for example, −screens scr0 scr1. If there are more screens than names, +resources for the remaining screens will be retrieved using the first name. +By default, the screen number is used for the screen name. + + +Windows +Default mwm window frames have distinct components +with associated functions: + +Title Area + +In addition to displaying the client's title, the title area is used +to move the window. To move the window, place the pointer over the title area, +press button 1 and drag the window to a new location. By default, a wire +frame is moved during the drag to indicate the new location. When the button +is released, the window is moved to the new location. + + +Title Bar + +The title bar includes the title area, the minimize button, the maximize +button, and the window menu button. In shaped windows, such as round windows, +the title bar floats above the window. + + +Minimize Button + +To turn the window into an icon, click button 1 on the minimize button +(the frame box with a small square in it). + + +Maximize Button + +To make the window fill the screen (or enlarge to the largest size allowed +by the configuration files), click button 1 on the maximize button (the frame +box with a large square in it). + + +Window Menu Button + +The window menu button is the frame box with a horizontal bar in it. +To pull down the window menu, press button 1. While pressing, drag the pointer +on the menu to your selection, then release the button when your selection +is highlighted. Pressing button 3 in the title bar or resize border handles +also posts the window menu. Alternately, you can click button 1 to pull down +the menu and keep it posted; then position the pointer and select. You can +also post the window menu by pressing <Shift> <Esc> or <Alt> <Space>. +Double-clicking button 1 with the pointer on the window menu button closes +the window. + + + +The following table lists the contents of the window menu. + + +Default Window Menu + + + + + + + + +Selection +Accelerator +Description + +Restore + +Restores the window to its size before minimizing +or maximizing. + +Move + +Allows the window to be moved with keys or +mouse. + +Size + +Allows the window to be resized. + + +Minimize + +Turns the window into an icon. + +Maximize + +Makes the window fill the screen. + + +Lower + +Moves window to bottom of window stack. + + +Close +Alt+F4 +Causes client to terminate. + + +Resize Border Handles + +To change the size of a window, move the pointer over a resize border +handle (the cursor changes), press button 1, and drag the window to a new +size. When the button is released, the window is resized. While dragging is +being done, a rubber-band outline is displayed to indicate the new window +size. + + +Matte + +An optional matte decoration can be added between the client area and +the window frame (see the matteWidth resource). A +matte is not actually part of the window frame. +There is no functionality associated with a matte. + + + + + +Icons +Icons are small graphic representations of windows. A window can be +minimized (iconified) using the minimize button on the window frame. Icons +provide a way to reduce clutter on the screen. +Pressing mouse button 1 when the pointer is over an icon causes the +icon's window menu to pop up. Releasing the button (press + release without +moving mouse = click) causes the menu to stay posted. The menu contains the +following selections: + + +Icon Window Menu + + + + + + + + +Selection +Accelerator +Description + +Restore + +Opens the associated window. + +Move + +Allows the icon to be moved with keys. + + +Size + +Inactive (not an option for icons). + + +Minimize + +Inactive (not an option for icons). + + +Maximize + +Opens the associated window and makes it +fill the screen. + +Lower + +Moves icon to bottom of icon stack. + + +Close +Alt+F4 +Removes client from mwm +management. +Note that pressing button 3 over an icon also causes the icon's window +menu to pop up. To make a menu selection, drag the pointer over the menu and +release button 3 when the desired item is highlighted. +Double-clicking button 1 on an icon invokes the f.restore_and_raise function and restores the icon's associated window to its previous +state. For example, if a maximized window is iconified, double-clicking button +1 restores it to its maximized state. Double-clicking button 1 on the icon +box's icon opens the icon box and allows access to the contained icons. (In +general, double-clicking a mouse button is a quick way to perform a function.) +Pressing <Shift> <Esc> or <Menu> (the pop-up menu key) causes the +icon window menu of the currently selected icon to pop up. + + +Icon Box +When icons begin to clutter the screen, they can be packed into an icon +box. (To use an icon box, mwm must be started with the +icon box configuration already set.) The icon box is a mwm +window that holds client icons. It includes one or more scroll bars when there +are more window icons than the icon box can show at the same time. +Icons in the icon box can be manipulated with the mouse. The following +table summarizes the behavior of this interface. Button actions apply whenever +the pointer is on any part of the icon. Note that double-clicking an icon +in the icon box invokes the f.restore_and_raise function. + + + + + + + + + +Button +Action +Description + +Button 1 +click +Selects the icon. + +Button 1 +double-click +Normalizes (opens) the associated window. +Raises an already open window to the top of the stack. + +Button 1 +drag +Moves the icon. + +Button 3 +press +Causes the menu for that icon to pop up. + +Button 3 +drag +Highlights items as the pointer moves across +the menu. +Pressing mouse button 3 when the pointer is over an icon causes the +menu for that icon to pop up. + + +Icon Menu for the Icon Box + + + + + + + + +Selection +Accelerator +Description + +Restore + +Opens the associated window (if not already +open). + +Move + +Allows the icon to be moved with keys. + + +Size + +Inactive. + +Minimize + +Inactive. + +Maximize + +Opens the associated window (if not already +open) and maximizes its size. + +Lower + +Inactive. + +Close +Alt+F4 +Removes client from mwm +management. +To pull down the window menu for the icon box itself, press button 1 +with the pointer over the menu button for the icon box. The window menu of +the icon box differs from the window menu of a client window: The "Close" +selection is replaced with the "PackIcons Shift+Alt+F7" selection. When selected, +PackIcons packs the icons in the box to achieve neat rows with no empty slots. + +You can also post the window menu by pressing <Shift>, <Esc> or +<Alt> <Space>. Pressing <Menu> (the pop-up menu key) causes the icon +window menu of the currently selected icon to pop up. + + +Input Focus +The mwm window manager supports (by default) a keyboard +input focus policy of explicit selection. This means when a window is selected +to get keyboard input, it continues to get keyboard input until the window +is withdrawn from window management, another window is explicitly selected +to get keyboard input, or the window is iconified. Several resources control +the input focus. The client window with the keyboard input focus has the active +window appearance with a visually distinct window frame. +The following tables summarize the keyboard input focus selection behavior: + + + + + + + + + +Button +Action +Object +Function Description + +Button 1 +press +Window / window frame +Keyboard focus selection. + +Button 1 +press +Icon +Keyboard focus selection. + + + + + + + + +Key Action +Function Description + +[Alt][Tab] +Move input focus to next window in window +stack (available only in explicit focus mode). + +[Alt][Shift][Tab] +Move input focus to previous window in window +stack (available only in explicit focus mode). + + + +Window Stacking +There are two types of window stacks: global window stacks and an application's +local family window stack. +The global stacking order of windows may be changed as a result of setting +the keyboard input focus, iconifying a window, or performing a window manager +window stacking function. When keyboard focus policy is explicit the default +value of the focusAutoRaise resource is True. This causes +a window to be raised to the top of the stack when it receives input focus, +for example, by pressing button 1 on the title bar. The key actions defined +in the previous table will thus raise the window receiving focus to the top +of the stack. +In pointer mode, the default value of focusAutoRaise +is False, that is, the window stacking order is not changed when a window +receives keyboard input focus. The following key actions can be used to cycle +through the global window stack. + + + + + + +Key Action +Function Description + +[Alt][ESC] +Place top window on bottom of stack. + + +[Alt][Shift][ESC] +Place bottom window on top of stack. + +By default, a window's icon is placed on the bottom of the stack when +the window is iconified; however, the default can be changed by the lowerOnIconify resource. +Transient windows (secondary windows such a dialog boxes) stay above +their parent windows by default; however, an application's local family stacking +order may be changed to allow a transient window to be placed below its parent +top-level window. The following arguments show the modification of the stacking +order for the f.lower function. + +f.lower + +Lowers the transient window within the family (staying above the parent) +and lowers the family in the global window stack. + + +f.lower [ within] + +Lowers the transient window within the family (staying above the parent) +but does not lower the family in the global window stack. + + +f.lower [freeFamily ] + +Lowers the window free from its family stack (below the parent), but +does not lower the family in the global window stack. + + + +The arguments within and freeFamily can also be used with f.raise +and f.raise_lower. + + + +Session Management + +The window manager is an X Session Management Protocol aware client. It responds to SaveYourself +(and other associated messages) by saving the geometries of its clients to a state file. +mwm can then be restarted by the XSMP session manager. +The default location for the state file is $HOME/.mwmclientdb. +This location can be overriden with the resource +sessionClientDB. + + + +X Resources +The mwm command is configured from its resource +database. This database is built from the following sources. They are listed +in order of precedence, low to high: +/usr/lib/X11/app-defaults/Mwm + +$HOME/Mwm + +RESOURCE_MANAGER root window property or $HOME/.Xdefaults + +XENVIRONMENT variable or $HOME/.Xdefaults-host + +mwm command line options + +The file names /usr/lib/X11/app-defaults/Mwm and $HOME/Mwm represent customary locations for these files. The actual +location of the system-wide class resource file may depend on the XFILESEARCHPATH environment variable and the +current language environment. The actual location of the user-specific class +resource file may depend on the XUSERFILESEARCHPATH and XAPPLRESDIR +environment variables and the current language environment. +Entries in the resource database may refer to other resource files for +specific types of resources. These include files that contain bitmaps, fonts, +and mwm specific resources such as menus and behavior +specifications (for example, button and key bindings). +Mwm is the resource class name of mwm and mwm is the default resource name used by mwm to look up resources. the −screens +command line option specifies resource names, such as "mwm_b+w" and "mwm_color".) +In the following discussion of resource specification, "Mwm" and "mwm" (and +the aliased mwm resource names) can be used interchangeably, +but "mwm" takes precedence over "Mwm". +The mwm command uses the following types of resources: + + +Component Appearance Resources: + +These resources specify appearance attributes of window manager user +interface components. They can be applied to the appearance of window manager +menus, feedback windows (for example, the window reconfiguration feedback +window), client window frames, and icons. + + +General Appearance and Behavior Resources: + +These resources specify mwm appearance and behavior +(for example, window management policies). They are not set separately for +different mwm user interface components. They apply to +all screens and workspaces. + + +Screen Specific Appearance and Behavior Resources: + +These resources specify the appearance and behavior of mwm elements that are settable on a per-screen basis. + + +Client Specific Resources: + +These mwm resources can be set for a particular +client window or class of client windows. They specify client-specific icon +and client window frame appearance and behavior. + + + +Resource identifiers can be either a resource name (for example, foreground) +or a resource class (for example, Foreground). If the value of a resource +is a filename and if the filename is prefixed by "~/", then it is relative +to the path contained in the HOME +environment variable (generally the user's home directory). + + +Component Appearance Resources +The syntax for specifying component appearance resources that apply +to window manager icons, menus, and client window frames is Mwm* resource_id +For example, Mwm*foreground is used to specify +the foreground color for mwm menus, icons, client window +frames, and feedback dialogs. +The syntax for specifying component appearance resources that apply +to a particular mwm component is Mwm*[menu|icon|client|feedback] *resource_id +If menu is specified, the resource is applied only +to mwm menus; if icon is specified, +the resource is applied to icons; and if client is specified, +the resource is applied to client window frames. For example, Mwm*icon*foreground is used to specify the foreground color for mwm +icons, Mwm*menu*foreground specifies the foreground +color for mwm menus, and Mwm*client*foreground is used to specify the foreground color for mwm +client window frames. +The appearance of the title area of a client window frame (including +window management buttons) can be separately configured. The syntax for configuring +the title area of a client window frame is Mwm*client*title* resource_id +For example, Mwm*client*title*foreground specifies +the foreground color for the title area. Defaults for title area resources +are based on the values of the corresponding client window frame resources. + +The appearance of menus can be configured based on the name of the menu. +The syntax for specifying menu appearance by name is Mwm*menu* menu_name*resource_id +For example, Mwm*menu*my_menu*foreground specifies +the foreground color for the menu named my_menu. The +user can also specify resources for window manager menu components, that is, +the gadgets that comprise the menu. These may include for example, a menu +title, title separator, one or more buttons, and separators. If a menu contains +more than one instance of a class, such as multiple PushButtonGadgets, the +name of the first instance is "PushButtonGadget1", the second is "PushButtonGadget2", +and so on. The following list identifies the naming convention used for window +manager menu components: + + +Menu Title LabelGadget − "TitleName" + + +Menu Title SeparatorGadget − "TitleSeparator" + + +CascadeButtonGadget − "CascadeButtonGadget<n>" + + +PushButtonGadget − "PushButtonGadget<n>" + + +SeparatorGadget − "SeparatorGadget<n>" + + +Refer to the man page for each class for a list of resources that can +be specified. +The following component appearance resources that apply to all window +manager parts can be specified: + + +Component Appearance Resources − All Window Manager Parts + + + + + + + + + +Name +Class +Value Type +Default + +background +Background +color +varies† + +backgroundPixmap +BackgroundPixmap +string†† +varies† + +bottomShadowColor +Foreground +color +varies† + +bottomShadowPixmap +Foreground +string†† +varies† + +fontList +FontList +string††† +"fixed" + +foreground +Foreground +color +varies† + +saveUnder +SaveUnder +T/F +F + +topShadowColor +Background +color +varies† + +topShadowPixmap +TopShadowPixmap +string†† +varies† + +†The default is chosen based on the visual type of the screen. +††Image name. See &cdeman.XmInstallImage;. †††X11 +X Logical Font Description + +background (class  Background) + +This resource specifies the background color. Any legal X color may +be specified. The default value is chosen based on the visual type of the +screen. + + +backgroundPixmap (class  BackgroundPixmap) + +This resource specifies the background Pixmap of the mwm +decoration when the window is inactive (does not have the keyboard focus). +The default value is chosen based on the visual type of the screen. + + +bottomShadowColor (class  Foreground) + +This resource specifies the bottom shadow color. This color is used +for the lower and right bevels of the window manager decoration. Any legal +X color may be specified. The default value is chosen based on the visual +type of the screen. + + +bottomShadowPixmap (class  BottomShadowPixmap) + +This resource specifies the bottom shadow Pixmap. This Pixmap is used +for the lower and right bevels of the window manager decoration. The default +is chosen based on the visual type of the screen. + + +fontList (class  FontList) + +This resource specifies the font used in the window manager decoration. +The character encoding of the font should match the character encoding of +the strings that are used. The default is "fixed." + + +foreground (class  Foreground) + +This resource specifies the foreground color. The default is chosen +based on the visual type of the screen. + + +saveUnder (class  SaveUnder) + +This is used to indicate whether "save unders" are used for mwm components. For this to have any effect, save unders must be +implemented by the X server. If save unders are implemented, the X server +saves the contents of windows obscured by windows that have the save under +attribute set. If the saveUnder resource is True, mwm will set the save under attribute on the window manager frame +of any client that has it set. If saveUnder is False, +save unders will not be used on any window manager frames. The default value +is False. + + +topShadowColor (class  Background) + +This resource specifies the top shadow color. This color is used for +the upper and left bevels of the window manager decoration. The default is +chosen based on the visual type of the screen. + + +topShadowPixmap ( class  TopShadowPixmap) + +This resource specifies the top shadow Pixmap. This Pixmap is used for +the upper and left bevels of the window manager decoration. The default is +chosen based on the visual type of the screen. + + + +The following component appearance resources that apply to frame and +icons can be specified: + + +Frame and Icon Components + + + + + + + + + +Name +Class +Value Type +Default + +activeBackground +Background +color +varies† + +activeBackgroundPixmap +BackgroundPixmap +string†† +varies† + +activeBottomShadowColor +Foreground +color +varies† + +activeBottomShadowPixmap +BottomShadowPixmap +string†† +varies† + +activeForeground +Foreground +color +varies† + +activeTopShadowColor +Background +color +varies† + +activeTopShadowPixmap +TopShadowPixmap +string†† +varies† + +†The default is chosen based on the visual type of the screen. +††See &cdeman.XmInstallImage;. + +activeBackground (class  Background) + +This resource specifies the background color of the mwm +decoration when the window is active (has the keyboard focus). The default +is chosen based on the visual type of the screen. + + +activeBackgroundPixmap (class  ActiveBackgroundPixmap) + +This resource specifies the background Pixmap of the mwm +decoration when the window is active (has the keyboard focus). The default +is chosen based on the visual type of the screen. + + +activeBottomShadowColor (class  Foreground) + +This resource specifies the bottom shadow color of the mwm decoration when the window is active (has the keyboard focus). +The default is chosen based on the visual type of the screen. + + +activeBottomShadowPixmap (class  BottomShadowPixmap) + +This resource specifies the bottom shadow Pixmap of the mwm decoration when the window is active (has the keyboard focus). +The default is chosen based on the visual type of the screen. + + +activeForeground (class  Foreground) + +This resource specifies the foreground color of the mwm +decoration when the window is active (has the keyboard focus). The default +is chosen based on the visual type of the screen. + + +activeTopShadowColor (class  Background) + +This resource specifies the top shadow color of the mwm +decoration when the window is active (has the keyboard focus). The default +is chosen based on the visual type of the screen. + + +activeTopShadowPixmap (class  TopShadowPixmap) + +This resource specifies the top shadow Pixmap of the mwm +decoration when the window is active (has the keyboard focus). The default +is chosen based on the visual type of the screen. + + + + + +General Appearance and Behavior Resources +The syntax for specifying general appearance and behavior resources +is Mwm*resource_id +For example, Mwm*keyboardFocusPolicy specifies +the window manager policy for setting the keyboard focus to a particular client +window. +The following general appearance and behavior resources can be specified: + + + +General Appearance and Behavior Resources + + + + + + + + + +Name +Class +Value Type +Default + +autoKeyFocus +AutoKeyFocus +T/F +T + +autoRaiseDelay +AutoRaiseDelay +millisec +500 + +bitmap- +Bitmap- +directory +/usr/include- + +Directory +Directory + +/X11/bitmaps + +clientAutoPlace +ClientAutoPlace +T/F +T + +colormapFocus- +ColormapFocus- +string +keyboard + +Policy +Policy + + + +configFile +ConfigFile +file +$HOME/mwmrc + +deiconifyKeyFocus +DeiconifyKeyFocus +T/F +T + +doubleClick- +DoubleClick- +millisec. +multi-click + +Time +Time + +time† + +enableWarp +enableWarp +T/F +T + +enforceKeyFocus +EnforceKeyFocus +T/F +T + +frameStyle +FrameStyle +string +recessed + +iconAutoPlace +IconAutoPlace +T/F +T + +iconClick +IconClick +T/F +T + +interactivePlacement +InteractivePlacement +T/F +T + +keyboardFocus- +KeyboardFocus- +string +explicit + +Policy +Policy + + + +lowerOnIconify +LowerOnIconify +T/F +T + +moveThreshold +MoveThreshold +pixels +4 + +multiScreen +MultiScreen +T/F +T + +passButtons +PassButtons +T/F +F + +passSelectButton +PassSelectButton +T/F +T + +positionIsFrame +PositionIsFrame +T/F +T + +positionOnScreen +PositionOnScreen +T/F +T + +quitTimeout +QuitTimeout +millisec. +1000 + +raiseKeyFocus +RaiseKeyFocus +T/F +F + +refreshByClearing +RefreshByClearing +T/F +T + +rootButtonClick +RootButtonClick +T/F +F + +screens +Screens +string +varies + +sessionClientDB +SessionClientDB +string +$HOME/.mwmclientdb + +showFeedback +ShowFeedback +string +all + +startupKeyFocus +StartupKeyFocus +T/F +T + +wMenuButtonClick +WMenuButtonClick +T/F +T + +wMenuButtonClick2 +WMenuButtonClick2 +T/F +T +†The resource doubleClickTime is included for backward compatibility. +Use of the Xt resource multiClickTime is preferred. + +autoKeyFocus (class  AutoKeyFocus) + +This resource is available only when the keyboard input focus policy +is explicit. If autoKeyFocus is given a value of True, +then when a window with the keyboard input focus is withdrawn from window +management or is iconified, the focus is set to the previous window that had +the focus. If the value given is False, there is no automatic setting of the +keyboard input focus. It is recommended that both autoKeyFocus and startupKeyFocus be True to work with +tear off menus. The default value is True. + + +autoRaiseDelay (class  AutoRaiseDelay) + +This resource is available only when the focusAutoRaise +resource is True and the keyboard focus policy is pointer. The autoRaiseDelay resource specifies the amount of time (in milliseconds) +that mwm will wait before raising a window after it gets +the keyboard focus. The default value of this resource is 500 (ms). + + +bitmapDirectory (class  BitmapDirectory) + +This resource identifies a directory to be searched for bitmaps referenced +by mwm resources. This directory is searched if a bitmap +is specified without an absolute pathname. The default value for this resource +is BR /usr/include/X11/bitmaps. The directory /usr/include/X11/bitmaps +represents the customary locations for this directory. The actual +location of this directory may vary on some systems. If the bitmap is not +found in the specified directory, XBMLANGPATH is searched. + + +clientAutoPlace (class  ClientAutoPlace) + +This resource determines the position of a window when the window has +not been given a program- or user-specified position. With a value of True, +windows are positioned with the top left corners of the frames offset horizontally +and vertically. A value of False causes the currently configured position +of the window to be used. In either case, mwm will attempt +to place the windows totally on-screen. The default value is True. + + +colormapFocusPolicy (class  ColormapFocusPolicy) + +This resource indicates the colormap focus policy that is to be used. +If the resource value is explicit, a colormap selection action is done on +a client window to set the colormap focus to that window. If the value is +pointer, the client window containing the pointer has the colormap focus. +If the value is keyboard, the client window that has the keyboard input focus +has the colormap focus. The default value for this resource is keyboard. + + +configFile (class  ConfigFile) + +The resource value is the pathname for a mwm resource +description file. If the pathname begins with "~/", mwm +considers it to be relative to the user's home directory (as specified by +the HOME environment variable). +If the LANG environment variable +is set, mwm looks for $HOME/$LANG/ configFile. If that file does not exist or if LANG is not set, mwm looks for +$HOME/configFile. If the configFile pathname does not begin with "~/" or "/", mwm considers it to be relative to the current working directory. If +the configFile resource is not specified +or if that file does not exist, mwm uses several default +paths to find a configuration file. The order of the search is shown below: $HOME/.dt/$LANG/mwmrc $HOME/.dt/mwmrc /etc/dt/config/$LANG/sys.mwmrc† +/etc/dt/config/sys.mwmrc† /usr/dt/config/$LANG/sys.mwmrc† +/usr/dt/config/sys.mwmrc† Paths marked with '†' are +implementation dependent. + + +deiconifyKeyFocus (class  DeiconifyKeyFocus) + +This resource applies only when the keyboard input focus policy is explicit. +If a value of True is used, a window receives the keyboard input focus when +it is normalized (deiconified). True is the default value. + + +doubleClickTime (class  DoubleClickTime) + +This resource is used to set the maximum time (in ms) between the clicks +(button presses) that make up a double-click. The use of this resource is +deprecated. Use the Xt resource multiClickTime instead. +The value of doubleClickTime dynamically defaults to +the value of multiClickTime. + + +enableWarp (class  EnableWarp) + +The default value of this resource, True, causes mwm +to warp the pointer to the center of the selected window during keyboard-controlled +resize and move operations. Setting the value to False causes mwm to leave the pointer at its original place on the screen, unless +the user explicitly moves it with the cursor keys or pointing device. + + +enforceKeyFocus (class  EnforceKeyFocus) + +If this resource is given a value of True, the keyboard input focus +is always explicitly set to selected windows even if there is an indication +that they are "globally active" input windows. (An example of a globally active +window is a scroll bar that can be operated without setting the focus to that +client.) If the resource is False, the keyboard input focus is not explicitly +set to globally active windows. The default value is True. + + +frameStyle (class  frameStyle) + +If this resource is given a value of "slab", the the window manager +frame is drawn such that the client area appears to be at the same height +as the top of the window frame. If the resource is set to "recessed", the +window frame is drawn such that the client area appears lower than the top +of the window frame. The default value is "recessed". + + +iconAutoPlace (class  IconAutoPlace) + +This resource indicates whether the window manager arranges icons in +a particular area of the screen or places each icon where the window was when +it was iconified. The value True indicates that icons are arranged in a particular +area of the screen, determined by the iconPlacement resource. +The value False indicates that an icon is placed at the location of the window +when it is iconified. The default is True. + + +iconClick (class  IconClick) + +When this resource is given the value of True, the system menu is posted +and left posted when an icon is clicked. The default value is True. + + +interactivePlacement (class  InteractivePlacement) + +This resource controls the initial placement of new windows on the screen. +If the value is True, the pointer shape changes before a new window is placed +on the screen to indicate to the user that a position should be selected for +the upper-left hand corner of the window. If the value is False, windows are +placed according to the initial window configuration attributes. The default +value of this resource is False. + + +keyboardFocusPolicy (class  KeyboardFocusPolicy) + +If set to pointer, the keyboard focus policy is to have the keyboard +focus set to the client window that contains the pointer (the pointer could +also be in the client window decoration that mwm adds). +If set to explicit, the policy is to have the keyboard focus set to a client +window when the user presses button 1 with the pointer on the client window +or any part of the associated mwm decoration. The default +value for this resource is explicit. + + +lowerOnIconify (class  LowerOnIconify) + +If this resource is given the default value of True, a window's icon +appears on the bottom of the window stack when the window is minimized (iconified). +A value of False places the icon in the stacking order at the same place as +its associated window. The default value of this resource is True. + + +moveThreshold (class  MoveThreshold) + +This resource is used to control the sensitivity of dragging operations +that move windows and icons. The value of this resource is the number of pixels +that the locator is moved with a button down before the move operation is +initiated. This is used to prevent window/icon movement when you click or +double-click and there is unintentional pointer movement with the button down. +The default value of this resource is 4 (pixels). + + +multiScreen (class  MultiScreen) + +This resource, if True, causes mwm to manage all +the screens on the display. If False, mwm manages only +a single screen. The default value is True. + + +passButtons (class  PassButtons) + +This resource indicates whether or not button press events are passed +to clients after they are used to do a window manager function in the client +context. If the resource value is False, the button press is not passed to +the client. If the value is True, the button press is passed to the client +window. The window manager function is done in either case. The default value +for this resource is False. + + +passSelectButton (class  PassSelectButton) + +This resource indicates whether or not to pass the select button press +events to clients after they are used to do a window manager function in the +client context. If the resource value is False, then the button press will +not be passed to the client. If the value is True, the button press is passed +to the client window. The window manager function is done in either case. +The default value for this resource is True. + + +positionIsFrame (class  PositionIsFrame) + +This resource indicates how client window position information (from +the WM_NORMAL_HINTS property and from configuration requests) +is to be interpreted. If the resource value is True, the information is interpreted +as the position of the mwm client window frame. If the +value is False, it is interpreted as being the position of the client area +of the window. The default value of this resource is True. + + +positionOnScreen (class  PositionOnScreen) + +This resource is used to indicate that windows should initially be placed +(if possible) so that they are not clipped by the edge of the screen (if the +resource value is True). If a window is larger than the size of the screen, +at least the upper-left corner of the window is on-screen. If the resource +value is False, windows are placed in the requested position even if totally +off-screen. The default value of this resource is True. + + +quitTimeout (class  QuitTimeout) + +This resource specifies the amount of time (in milliseconds) that mwm will wait for a client to update the WM_COMMAND +property after mwm has sent the WM_SAVE_YOURSELF message. The default value of this resource is 1000 (ms). (Refer +to the f.kill function description for additional information.) + + + +raiseKeyFocus (class  RaiseKeyFocus) + +This resource is available only when the keyboard input focus policy +is explicit. When set to True, this resource specifies that a window raised +by means of the f.normalize_and_raise function also receives +the input focus. The default value of this resource is False. + + +refreshByClearing (class  RefreshByClearing) + +This resource determines the mechanism used to refresh a window (or +the screen) when the f.refresh_win (f.refresh) function is executed. When set to True, an XClearArea is performed +over the window for f.refresh_win. When set to False, +a covering window is created and destroyed over the top of the window to be +refreshed. If the function is f.refresh and this resource +is set to True, then an XClearArea is performed over every window on the screen. +If the resource is set to False, then one large window covering the entire +screen is created and destroyed. The default value of this resource is True. + + + +rootButtonClick (class  RootButtonClick) + +The rootButtonClick resource controls whether the +a click on the root window will post the root menu in a "sticky" mode. If +this resource is set to True, a button click on the root window will post +the menu bound to the button down event for that button in a "sticky" fashion. +If this resource is set to False, then the same button click would only cause +the menu to flash as it would be unposted once the button up event is seen. +The criterion used to determine if it is a button click is if the pointer +doesn't move between the button down and button up events. The default value +for this resource is True. + + +screens (class  Screens) + +This resource specifies the resource names to use for the screens managed +by mwm. If mwm is managing a single +screen, only the first name in the list is used. If mwm +is managing multiple screens, the names are assigned to the screens in order, +starting with screen 0. Screen 0 gets the first name, screen 1 the second +name, and so on. The default screen names are 0, 1, and so on. + + + +sessionClientDB (class  SessionClientDB) + +This resource identifies a file name to use as a root when saving state +at the request of an XSMP session manager. When the session is saved, the window manager will then reuse +the file name by automatically incrementing a suffix. + + + +showFeedback (class  ShowFeedback) + +This resource controls whether or not feedback windows or confirmation +dialogs are displayed. A feedback window shows a client window's initial +placement and shows position and size during move and resize operations. +Confirmation dialogs can be displayed for certain operations. The value for +this resource is a list of names of the feedback options to be enabled or +disabled; the names must be separated by a space. If an option is preceded +by a minus sign, that option is excluded from the list. The sign of the first item in the list determines the initial set of options. +If the sign of the first option is minus, mwm assumes +all options are present and starts subtracting from that set. If the sign +of the first decoration is plus (or not specified), mwm +starts with no options and builds up a list from the resource. + + + +The names of the feedback options are shown below: + + + + + + +Name +Description + +all +Show all feedback (Default value). + + +behavior +Confirm behavior switch. + +kill +Confirm on receipt of KILL signal. + + +move +Show position during move. + +none +Show no feedback. + +placement +Show position and size during initial placement. + +quit +Confirm quitting mwm. + +resize +Show size during resize. + +restart +Confirm mwm restart. +The following command line illustrates the syntax for showFeedback: + + +Mwm*showFeedback: placement resize behavior restart + +This resource specification provides feedback for initial client placement +and resize, and enables the dialog boxes to confirm the restart and set behavior +functions. It disables feedback for the move function. The default value for +this resource is all. + +startupKeyFocus (class  StartupKeyFocus) + +This resource is available only when the keyboard input focus policy +is explicit. When given the default value of True, a window gets the keyboard +input focus when the window is mapped (that is, initially managed by the window +manager). It is recommended that both autoKeyFocus and startupKeyFocus be True to work with tear off menus. The default +value is True. + + +wMenuButtonClick (class  WMenuButtonClick) + +This resource indicates whether a click of the mouse when the pointer +is over the window menu button posts and leaves posted the window menu. If +the value given this resource is True, the menu remains posted. True is the +default value for this resource. + + +wMenuButtonClick2 (class  WMenuButtonClick2) + +When this resource is given the default value of True, a double-click +action on the window menu button does an f.kill function. + + + + + + +Screen Specific Appearance and Behavior Resources +The syntax for specifying screen specific resources is Mwm* screen_name*resource_id For example, Mwm*1*keyBindings specifies +the key bindings to use for screen "1". + + +Screen Specific Resources + + + + + + + + + +Name +Class +Value Type +Default + +buttonBindings +ButtonBindings +string +DefaultButtonBindings + +cleanText +CleanText +T/F +T + +fadeNormalIcon +FadeNormalIcon +T/F +F + +feedbackGeometry +FeedbackGeometry +string +center on screen + +frameBorderWidth +FrameBorderWidth +pixels +varies + +iconBoxGeometry +IconBoxGeometry +string +6x1+0-0 + +iconBoxName +IconBoxName +string +iconbox + +iconBoxSBDisplayPolicy +IconBoxSBDisplayPolicy +string +all + +iconBoxTitle +IconBoxTitle +XmString +Icons + +iconDecoration +IconDecoration +string +varies + +iconImageMaximum +IconImageMaximum +wxh +48x48 + +iconImageMinimum +IconImageMinimum +wxh +16x16 + +iconPlacement +IconPlacement +string +left bottom + +iconPlacementMargin +IconPlacementMargin +pixels +varies + +keyBindings +KeyBindings +string +DefaultKeyBindings + +limitResize +LimitResize +T/F +T + +maximumMaximumSize +MaximumMaximumSize +wxh (pixels) +2X screen w&h + +moveOpaque +MoveOpaque +T/F +F + +resizeBorderWidth +ResizeBorderWidth +pixels +varies + +resizeCursors +ResizeCursors +T/F +T + +transientDecoration +TransientDecoration +string +menu title + +transientFunctions +TransientFunctions +string +−minimize−maximize + +useIconBox +UseIconBox +T/F +F + + +buttonBindings (class  ButtonBindings) + +This resource identifies the set of button bindings for window management +functions. The named set of button bindings is specified in the mwm resource description file. These button bindings are merged with the built-in default bindings. The default value for +this resource is "DefaultButtonBindings". + + +cleanText (class  CleanText) + +This resource controls the display of window manager text in the client +title and feedback windows. If the default value of True is used, the text +is drawn with a clear (no stipple) background. This makes text easier to read +on monochrome systems where a backgroundPixmap is specified. Only the stippling +in the area immediately around the text is cleared. If False, the text is +drawn directly on top of the existing background. + + +fadeNormalIcon (class  FadeNormalIcon) + +If this resource is given a value of True, an icon is grayed out whenever +it has been normalized (its window has been opened). The default value is +False. + + +feedbackGeometry (class  FeedbackGeometry) + +This resource sets the position of the move and resize feedback window. +If this resource is not specified, the default is to place the feedback window +at the center of the screen. The value of the resource is a standard window +geometry string with the following syntax: [=]{ +-}xoffset{+-} yoffset] + + +frameBorderWidth (class  FrameBorderWidth) + +This resource specifies the width (in pixels) of a client window frame +border without resize handles. The border width includes the 3-D shadows. +The default value is based on the size and resolution of the screen. + + +iconBoxGeometry (class  IconBoxGeometry) + +This resource indicates the initial position and size of the icon box. +The value of the resource is a standard window geometry string with the following +syntax: [=][width xheight][{+-}xoffset {+-}yoffset] If the offsets +are not provided, the iconPlacement policy is used to determine the initial +placement. The units for width and height are columns and rows. The actual +screen size of the icon box window depends on the iconImageMaximum (size) +and iconDecoration resources. The default value for size +is (6 * iconWidth + padding) wide by (1 * iconHeight + padding) high. The +default value of the location is +0 -0. + + +iconBoxName (class  IconBoxName) + +This resource specifies the name that is used to look up icon box resources. +The default name is iconbox. + + +iconBoxSBDisplayPolicy (class  IconBoxSBDisplayPolicy) + +This resource specifies the scroll bar display policy of the window +manager in the icon box. The resource has three possible values: all, vertical, +and horizontal. The default value, "all", causes both vertical and horizontal +scroll bars always to appear. The value "vertical" causes a single vertical +scroll bar to appear in the icon box and sets the orientation of the icon +box to horizontal (regardless of the iconBoxGeometry specification). The value +"horizontal" causes a single horizontal scroll bar to appear in the icon box +and sets the orientation of the icon box to vertical (regardless of the iconBoxGeometry +specification). + + +iconBoxTitle (class  IconBoxTitle) + +This resource specifies the name that is used in the title area of the +icon box frame. The default value is Icons. + + +iconDecoration (class  IconDecoration) + +This resource specifies the general icon decoration. The resource value +is label (only the label part is displayed) or image (only the image part +is displayed) or label image (both the label and image parts are displayed). +A value of activelabel can also be specified to get a label (not truncated +to the width of the icon) when the icon is selected. The default icon decoration +for icon box icons is that each icon has a label part and an image part (label +image). The default icon decoration for stand alone icons is that each icon +has an active label part, a label part, and an image part (activelabel label +image). + + +iconImageMaximum (class  IconImageMaximum) + +This resource specifies the maximum size of the icon image. The resource +value is widthx height (for example, 64x64). The maximum supported size is 128x128. +The default value of this resource is 50x50. + + +iconImageMinimum (class  IconImageMinimum) + +This resource specifies the minimum size of the icon image. The resource +value is widthx height (for example, 32x50). The minimum supported size is 16x16. +The default value of this resource is 16x16. + + +iconPlacement (class  IconPlacement) + +This resource specifies the icon placement scheme to be used. The resource +value has the following syntax: +primary_layout secondary_layout [tight] + + + +The layout values are one of the following: + + + + + + +Value +Description + +top +Lay the icons out top to bottom. + + +bottom +Lay the icons out bottom to top. + + +left +Lay the icons out left to right. + + +right +Lay the icons out right to left. + +A horizontal (vertical) layout value should not be used for both the primary_layout and the secondary_layout (for +example, don't use top for the primary_layout and bottom +for the secondary_layout). +The primary_layout indicates whether, when an icon +placement is done, the icon is placed in a row or a column and the direction +of placement. The secondary_layout indicates where to place +new rows or columns. For example, top right indicates that icons should be +placed top to bottom on the screen and that columns should be added from right +to left on the screen. +The default placement is left bottom (icons are placed left to right +on the screen, with the first row on the bottom of the screen, and new rows +added from the bottom of the screen to the top of the screen). A tight value places icons with zero spacing in between icons. This +value is useful for aesthetic reasons, as well as X-terminals with small screens. + + +iconPlacementMargin (class  IconPlacementMargin) + +This resource sets the distance between the edge of the screen and the +icons that are placed along the edge of the screen. The value should be greater +than or equal to 0. A default value (see below) is used if the value specified +is invalid. The default value for this resource is equal to the space between +icons as they are placed on the screen (this space is based on maximizing +the number of icons in each row and column). + + +keyBindings (class  KeyBindings) + +This resource identifies the set of key bindings for window management +functions. If specified, these key bindings replace the +built-in default bindings. The named set of key bindings is specified in mwm resource description file. The default value for this resource +is "DefaultKeyBindings". + + +limitResize (class  LimitResize) + +If this resource is True, the user is not allowed to resize a window +to greater than the maximum size. The default value for this resource is True. + + + +maximumMaximumSize (class  MaximumMaximumSize) + +This resource is used to limit the maximum size of a client window as +set by the user or client. The resource value is widthxheight (for example, 1024x1024) +where the width and height are in pixels. The default value of this resource +is twice the screen width and height. + + +moveOpaque (class  MoveOpaque) + +This resource controls whether the actual window is moved or a rectangular +outline of the window is moved. A default value of False displays a rectangular +outline on moves. + + +resizeBorderWidth (class  ResizeBorderWidth) + +This resource specifies the width (in pixels) of a client window frame +border with resize handles. The specified border width includes the 3-D shadows. +The default value is based on the size and resolution of the screen. + + +resizeCursors (class  ResizeCursors) + +This is used to indicate whether the resize cursors are always displayed +when the pointer is in the window size border. If True, the cursors are shown, +otherwise the window manager cursor is shown. The default value is True. + + +transientDecoration (class  TransientDecoration) + +This controls the amount of decoration that mwm +puts on transient windows. The decoration specification is exactly the same +as for the clientDecoration (client specific) resource. +Transient windows are identified by the WM_TRANSIENT_FOR +property, which is added by the client to indicate a relatively temporary +window. The default value for this resource is menu title (that is, transient +windows have frame borders and a titlebar with a window menu button). +An application can also specify which decorations mwm +should apply to its windows. If it does so, mwm applies +only those decorations indicated by both the application and the transientDecoration resource. Otherwise, mwm +applies the decorations indicated by the transientDecoration +resource. For more information see the description of XmNmwmDecorations on the &cdeman.VendorShell; +reference page. + + +transientFunctions (class  TransientFunctions) + +This resource is used to indicate which window management functions +are applicable (or not applicable) to transient windows. The function specification +is exactly the same as for the clientFunctions (client +specific) resource. The default value for this resource is -minimize -maximize. + +An application can also specify which functions mwm +should apply to its windows. If it does so, mwm applies +only those functions indicated by both the application and the transientFunctions resource. Otherwise, mwm +applies the functions indicated by the transientFunctions +resource. For more information see the description of XmNmwmFunctions on the &cdeman.VendorShell; reference +page. + + +useIconBox (class  UseIconBox) + +If this resource is given a value of True, icons are placed in an icon +box. When an icon box is not used, the icons are placed on the root window +(default value). + + + + + +Client Specific Resources +The syntax for specifying client specific resources is +Mwm*client_name_or_class *resource_id +For example, Mwm*mterm*windowMenu is used to specify +the window menu to be used with mterm clients. The syntax for specifying client +specific resources for all classes of clients is +Mwm*resource_id +Specific client specifications take precedence over the specifications +for all clients. For example, Mwm*windowMenu is used +to specify the window menu to be used for all classes of clients that don't +have a window menu specified. +The syntax for specifying resource values for windows that have an unknown +name and class (that is, windows that do not have a WM_CLASS +property associated with them) is +Mwm*defaults*resource_id +For example, Mwm*defaults*iconImage is used to +specify the icon image to be used for windows that have an unknown name and +class. +The following client specific resources can be specified: + + +Client Specific Resources + + + + + + + + + +Name +Class +Value Type +Default + +clientDecoration +ClientDecoration +string +all. + +clientFunctions +ClientFunctions +string +all. + +focusAutoRaise +FocusAutoRaise +T/F +varies + +iconImage +IconImage +pathname +(image) + +iconImage- +Background +color +icon background + +Background + + + + +iconImageBottom- +Foreground +color +icon + +ShadowColor + + +bottom shadow + +iconImageBottom- +BottomShadow- +color +icon bottom + +ShadowPixmap +Pixmap + +shadow pixmap + +iconImageForeground +Foreground +color +varies + +iconImageTopShadowColor +Background +color +icon top + + + + +shadow color + +iconImageTop- +TopShadowPixmap +color +icon top + +ShadowPixmap + + +shadow pixmap + +matteBackground +Background +color +background + +matteBottom- +Foreground +color +bottom + +ShadowColor + + +shadow color + +matteBottom- +BottomShadow- +color +bottom + +ShadowPixmap +Pixmap + +shadow pixmap + +matteForeground +Foreground +color +foreground + +matteTopShadowColor +Background +color +top + + + + +shadow color + +matteTopShadowPixmap +TopShadowPixmap +color +top + + + + +shadow pixmap + +matteWidth +MatteWidth +pixels +0 + +maximumClientSize +MaximumClientSize +wxh + + + +vertical horizontal +fill the screen + +useClientIcon +UseClientIcon +T/F +T + +usePPosition +UsePPosition +string +nonzero + +windowMenu +WindowMenu +string +DefaultWindowMenu + + +clientDecoration (class  ClientDecoration) + +This resource controls the amount of window frame decoration. The resource +is specified as a list of decorations to specify their inclusion in the frame. +If a decoration is preceded by a minus sign, that decoration is excluded from +the frame. The sign of the first item in the list determines +the initial amount of decoration. If the sign of the first decoration is minus, mwm assumes all decorations are present and starts subtracting +from that set. If the sign of the first decoration is plus (or not specified), +then mwm starts with no decoration and builds up a list +from the resource. +An application can also specify which decorations mwm +should apply to its windows. If it does so, mwm applies +only those decorations indicated by both the application and the clientDecoration resource. Otherwise, mwm applies +the decorations indicated by the clientDecoration resource. +For more information see the description of XmNmwmDecorations on the &cdeman.VendorShell; reference +page. + + + + + + + + + +Name +Description + +all +Include all decorations (default value). + +border +Window border. + +maximize +Maximize button (includes title bar). + + +minimize +Minimize button (includes title bar). + + +none +No decorations. + +resizeh +Border resize handles (includes border). + +menu +Window menu button (includes title bar). + +title +Title bar (includes border). + +Examples: Mwm*XClock.clientDecoration: -resizeh -maximize This removes the resize handles and maximize button from XClock +windows. Mwm*XClock.clientDecoration: menu minimize border This does the same thing as above. Note that either menu or minimize implies +title. + +clientFunctions (class  ClientFunctions) + +This resource is used to indicate which mwm functions +are applicable (or not applicable) to the client window. The value for the +resource is a list of functions. If the first function in the list has a minus +sign in front of it, then mwm starts with all functions +and subtracts from that set. If the first function in the list has a plus +sign in front of it, then mwm starts with no functions +and builds up a list. Each function in the list must be preceded by the appropriate +plus or minus sign and separated from the next function by a space. +An application can also specify which functions mwm +should apply to its windows. If it does so, mwm applies +only those functions indicated by both the application and the clientFunctions resource. Otherwise, mwm applies +the functions indicated by the clientFunctions resource. +For more information see the description of XmNmwmFunctions on the &cdeman.VendorShell; reference +page. + + + +The following table lists the functions available for this resource: + + + + + + + +Name +Description + +all +Include all functions (default value). + + +none +No functions. + +resize +f.resize†. + +move +f.move†. + +minimize +f.minimize†. + +maximize +f.maximize†. + +close +f.kill†. + +†See &cdeman.mwmrc;. + +focusAutoRaise (class  FocusAutoRaise) + +When the value of this resource is True, clients are raised when they +get the keyboard input focus. If the value is False, the stacking of windows +on the display is not changed when a window gets the keyboard input focus. +The default value is True when the keyboardFocusPolicy is explicit and False +when the keyboardFocusPolicy is pointer. + + +iconImage (class  IconImage) + +This resource can be used to specify an icon image for a client (for +example, "Mwm*myclock*iconImage"). The resource value is a pathname for a +pixmap or bitmap file. The value of the (client specific) useClientIcon resource is used to determine whether or not user supplied icon +images are used instead of client supplied icon images. The default value +is to display a built-in window manager icon image. + + +iconImageBackground (class  Background) + +This resource specifies the background color of the icon image that +is displayed in the image part of an icon. The default value of this resource +is the icon background color (that is, specified by "Mwm*background or Mwm*icon*background). + + + +iconImageBottomShadowColor (class  Foreground) + +This resource specifies the bottom shadow color of the icon image that +is displayed in the image part of an icon. The default value of this resource +is the icon bottom shadow color (that is, specified by Mwm*icon*bottomShadowColor). + + + +iconImageBottomShadowPixmap (class  BottomShadowPixmap) + +This resource specifies the bottom shadow Pixmap of the icon image that +is displayed in the image part of an icon. The default value of this resource +is the icon bottom shadow Pixmap (that is, specified by Mwm*icon*bottomShadowPixmap). + + + +iconImageForeground (class  Foreground) + +This resource specifies the foreground color of the icon image that +is displayed in the image part of an icon. The default value of this resource +varies depending on the icon background. + + +iconImageTopShadowColor (class  Background) + +This resource specifies the top shadow color of the icon image that +is displayed in the image part of an icon. The default value of this resource +is the icon top shadow color (that is, specified by Mwm*icon*topShadowColor). + + + +iconImageTopShadowPixmap (class  TopShadowPixmap) + +This resource specifies the top shadow Pixmap of the icon image that +is displayed in the image part of an icon. The default value of this resource +is the icon top shadow pixmap (that is, specified by Mwm*icon*topShadowPixmap). + + + +matteBackground  (class  Background) + +This resource specifies the background color of the matte, when matteWidth is positive. The default value of this resource is the +client background color (that is, specified by "Mwm*background or Mwm*client*background). + + + +matteBottomShadowColor (class  Foreground) + +This resource specifies the bottom shadow color of the matte, when matteWidth is positive. The default value of this resource is the +client bottom shadow color (that is, specified by Mwm*bottomShadowColor or +Mwm*client*bottomShadowColor). + + +matteBottomShadowPixmap (class  BottomShadowPixmap) + +This resource specifies the bottom shadow Pixmap of the matte, when matteWidth is positive. The default value of this resource is the +client bottom shadow pixmap (that is, specified by Mwm*bottomShadowPixmap +or Mwm*client*bottomShadowPixmap). + + +matteForeground (class  Foreground) + +This resource specifies the foreground color of the matte, when matteWidth is positive. The default value of this resource is the +client foreground color (that is, specified by Mwm*foreground or Mwm*client*foreground). + + + +matteTopShadowColor (class  Background) + +This resource specifies the top shadow color of the matte, when matteWidth is positive. The default value of this resource is the +client top shadow color (that is, specified by Mwm*topShadowColor or Mwm*client*topShadowColor). + + + +matteTopShadowPixmap (class  TopShadowPixmap) + +This resource specifies the top shadow pixmap of the matte, when matteWidth is positive. The default value of this resource is the +client top shadow pixmap (that is, specified by "Mwm*topShadowPixmap or Mwm*client*topShadowPixmap). + + + +matteWidth (class  MatteWidth) + +This resource specifies the width of the optional matte. The default +value is 0, which effectively disables the matte. + + +maximumClientSize (class  MaximumClientSize) + +This resource is either a size specification or a direction that indicates +how a client window is to be maximized. The resource value can be specified +as a size specification widthxheight. The width and height are interpreted in +the units that the client uses (for example, for terminal emulators this is +generally characters). Alternately, "vertical" or "horizontal" can be specified +to indicate the direction in which the client maximizes. +If this resource is not specified, the maximum size from the WM_NORMAL_HINTS property is used if set. Otherwise the default +value is the size where the client window with window management borders fills +the screen. When the maximum client size is not determined by the maximumClientSize resource, the maximumMaximumSize +resource value is used as a constraint on the maximum size. + + +useClientIcon (class  UseClientIcon) + +If the value given for this resource is True, a client-supplied icon +image takes precedence over a user-supplied icon image. The default value +is True, giving the client-supplied icon image higher precedence than the +user-supplied icon image. + + +usePPosition (class  UsePPosition) + +This resource specifies whether Mwm honors program specified position PPosition specified in the WM_NORMAL_HINTS property in the absence of an user specified position. Setting +this resource to on, causes mwm to always honor program +specified position. Setting this resource to off, causes mwm +to always ignore program specified position. Setting this resource to the +default value of nonzero cause mwm to honor program specified +position other than (0,0). + + +windowMenu (class  WindowMenu) + +This resource indicates the name of the menu pane that is posted when +the window menu is popped up (usually by pressing button 1 on the window +menu button on the client window frame). Menu panes are specified in the mwm resource description file. Window menus can be customized on +a client class basis by creating custom menus in your mwmrc +file (see &cdeman.mwmrc; and specifying resources to activate +the custom menus. The resources have the form Mwm* client_name_or_class*windowMenu. The default +value of this resource is DefaultWindowMenu. + + + + + +Resource Description File +The mwm resource description file is a supplementary +resource file that contains resource descriptions that are referred to by +entries in the resource manager property (see xrdb(1) and +the defaults files (.Xdefaults, app-defaults/Mwm ). It contains descriptions of resources that are to be used by mwm, and that cannot be easily encoded in the defaults files (a +bitmap file is an analogous type of resource description file). A particular mwm resource description file can be selected using the +configFile resource. +The following types of resources can be described in the mwm resource description file: + +Buttons + +Window manager functions can be bound (associated) with button events. + + + +Keys + +Window manager functions can be bound (associated) with key press events. + + + +Menus + +Menu panes can be used for the window menu and other menus posted with +key bindings and button bindings. +The mwm resource description file is described in &cdeman.mwmrc;. + + + + + +Environment +The mwm window manager uses the environment variable HOME specifying the user's home directory. + +The mwm window manager uses the environment variable LANG specifying the user's choice of language +for the mwm message catalog and the mwm +resource description file. +The mwm window uses the environment variable XFILESEARCHPATH, XUSERFILESEARCHPATH, XAPPLRESDIR, XENVIRONMENT, LANG, and HOME in determining search paths for resource defaults files. +The mwm window manager may also us XBMLANGPATH to search for bitmap files. +The mwm window manager reads the $HOME/.motifbind +file if it exists to install a virtual key bindings property on +the root window. For more information on the content of the .motifbind file, see +The mwm window manager uses the environment variable +MWMSHELL (or SHELL, if MWMSHELL is not set), specifying +the shell to use when executing commands via the f.exec +function. + + +Files +/usr/lib/X11/$LANG/system.mwmrc +/usr/lib/X11/system.mwmrc +/usr/lib/X11/app-defaults/Mwm +$HOME/Mwm +$HOME/$LANG/.mwmrc +$HOME/.mwmrc + + +RELATED INFORMATION +&cdeman.VendorShell;, &cdeman.VirtualBindings;, X(1), &cdeman.XmInstallImage;, xrdb(1). + + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR1X/uil.sgm b/cde/imports/motif/doc/C/guides/man/PR1X/uil.sgm new file mode 100644 index 00000000..1abfb98e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR1X/uil.sgm @@ -0,0 +1,157 @@ + + + + + + + + + + +uil +user cmd + + +uil +The user interface language compiler + +user interface language + +user interface language +compiler + + + +uil + +uil +compiler + + + +uil + +options + +file + + + +DESCRIPTION +The +uil +command invokes the UIL compiler. The User Interface +Language (UIL) +is a specification language for describing the initial state of a user +interface for a Motif application. The specification describes the +objects (menus, dialog boxes, labels, push buttons, and so on) used +in the interface and specifies the routines to be called when the +interface changes state as a result of user interaction. + + + +file + +Specifies the file to be compiled +through the UIL compiler. + + + + +options + +Specifies one or more of the following options: + + + +−Ipathname + +This option causes the compiler to look for include files +in the directory specified if the include files have not been +found in the paths that already were searched. +Specify this option followed by a pathname, with no intervening +spaces. + + + + +−m + +Machine code is listed. This directs the compiler to place in the +listing file a description of the +records that it added to the User Interface Database (UID). This helps you isolate +errors. The default is no machine code. + + + + +−o file + + +user interface database + +uid file + +Directs the compiler to produce a UID. +By default, UIL creates a UID with the name a.uid. +The file specifies the filename for the UID. +No UID is produced if the compiler issues any diagnostics +categorized as error or severe. UIDs are portable only across same-size +machine architectures. + + + + +−s + +Directs the compiler to set the locale before compiling any files. +The locale is set in an implementation-dependent manner. +On ANSI C-based systems, the locale is usually set by calling +setlocale(LC_ALL, ""). +If this option is not specified, the compiler does not set the +locale. + + + + +−v file + +Directs the compiler to generate a listing. +The file specifies the filename for the listing. +If the −v option is not present, +no listing is generated by the compiler. +The default is no listing. + + + + +−w + +Specifies that the +compiler suppress all warning and informational messages. +If this option is not present, all messages are +generated, +regardless of the severity. + + + + +−wmd file + +Specifies a binary widget meta-language description file to +be used in place of the default WML description. + + + + + + + + + +RELATED INFORMATION +X(1) and &cdeman.Uil3;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR1X/xmbind.sgm b/cde/imports/motif/doc/C/guides/man/PR1X/xmbind.sgm new file mode 100644 index 00000000..c21d31db --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR1X/xmbind.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +xmbind +user cmd + + +xmbind +Configures virtual key bindings + +xmbind + + + + + + + + + + + + + + + + + + + + + +xmbind + +options + + +file + + + + +DESCRIPTION +xmbind is an X Window System client that configures the virtual +key bindings for Motif applications. This action is performed by mwm +at its startup, so the xmbind client is only needed when mwm +is not in use, or when you want to change bindings without restarting +mwm. If a file is specified, +its contents are used as the virtual key bindings. If a file is not +specified, the file &npzwc;.motifbind in the user's home directory +is used. If this file is not found, xmbind loads the default +virtual key bindings, as described in &cdeman.VirtualBindings;. + + +Options + + +−display + +This option specifies the display to use; see X(1). + + + + + + + +RELATED +&cdeman.VirtualBindings; and +X(1). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Applic.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Applic.sgm new file mode 100644 index 00000000..5f68bbd4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Applic.sgm @@ -0,0 +1,871 @@ + + + + + + + + + + + +ApplicationShell +library call + + +ApplicationShell +The ApplicationShell widget class + +ApplicationShell + +widget class +ApplicationShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +ApplicationShell is used as the main top-level window for an application. An +application should have more than one ApplicationShell only if it implements +multiple logical applications. + + +Classes +ApplicationShell inherits behavior and resources from Core, +Composite, Shell, +WMShell, VendorShell, and TopLevelShell. + +The class pointer is applicationShellWidgetClass. + +The class name is ApplicationShell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +ApplicationShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNargc +XmCArgc +int +0 +CSG + + +XmNargv +XmCArgv +String * +NULL +CSG + + + + + + +XmNargc + +Specifies the number of arguments given in the XmNargv resource. +The function XtInitialize sets this resource on +the shell widget instance it creates by using its +parameters as the values. + + + + +XmNargv + +Specifies the argument list required by a session manager to restart the +application if it is killed. This list should be updated at +appropriate points by the application if a new state has been reached that can +be directly restarted. +The function XtInitialize sets this resource on +the shell widget instance it creates by using its +parameters as the values. +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + + + +Inherited Resources +ApplicationShell inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +TopLevelShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNiconic +XmCIconic +Boolean +False +CSG + + +XmNiconName +XmCIconName +String +NULL +CSG + + +XmNiconNameEncoding +XmCIconNameEncoding +Atom +dynamic +CSG + + + + + + + + + + + + + + +VendorShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNaudibleWarning +XmCAudibleWarning +unsigned char +XmBELL +CSG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNdeleteResponse +XmCDeleteResponse +unsigned char +XmDESTROY +CSG + + + +XmNinputMethod +XmCInputMethod +String +NULL +CSG + + +XmNinputPolicy +XmCInputPolicy +XmInputPolicy +XmPER_SHELL +CSG + + +XmNkeyboardFocusPolicy +XmCKeyboardFocusPolicy +unsigned char +XmEXPLICIT +CSG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTabel +XmRenderTable +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + +XmNmwmDecorations +XmCMwmDecorations +int +-1 +CG + + +XmNmwmFunctions +XmCMwmFunctions +int +-1 +CG + + +XmNmwmInputMode +XmCMwmInputMode +int +-1 +CG + + +XmNmwmMenu +XmCMwmMenu +String +NULL +CG + + +XmNpreeditType +XmCPreeditType +String +dynamic +CSG + + +XmNshellUnitType +XmCShellUnitType +unsigned char +XmPIXELS +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +XmPIXELS +CSG + + +XmNuseAsyncGeometry +XmCUseAsyncGeometry +Boolean +False +CSG + + + + + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +True +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +False +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +XmNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +False +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for ApplicationShell. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, &cdeman.Shell;, &cdeman.WMShell;, +&cdeman.VendorShell;, and &cdeman.TopLevelShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Compos.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Compos.sgm new file mode 100644 index 00000000..72db1a55 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Compos.sgm @@ -0,0 +1,398 @@ + + + + + + + + + + + +Composite +library call + + +Composite +The Composite widget class + +Composite + +widget class +Composite + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;&npzwc;#include <Xm/Xm.h> + + +DESCRIPTION +Composite widgets are intended to be containers for other widgets and can +have an arbitrary number of children. Their responsibilities (implemented +either directly by the widget class or indirectly by Intrinsics +functions) include: + + + +Overall management of children from creation to destruction. + + + +Destruction of descendants when the composite widget is destroyed. + + + +Physical arrangement (geometry management) of a displayable subset of +managed children. + + + +Mapping and unmapping of a subset of the managed children. +Instances of composite widgets need to specify the order in which +their children are kept. For example, an application may want a set of +command buttons in some logical order grouped by function, and it may want +buttons that represent filenames to be kept in alphabetical order. + + + + +Classes +Composite inherits behavior and resources from Core. + +The class pointer is compositeWidgetClass. + +The class name is Composite. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + +XmNchildren + +A read-only list of the children of the widget. + + + + +XmNinsertPosition + +Points to the XtOrderProc function described below. + + + + +XmNnumChildren + +A read-only resource specifying the length of the list of children in +XmNchildren. + + + + +The following procedure pointer in a composite widget instance is of type +XtOrderProc: + +Cardinal (* XtOrderProc) (Widget w); + + + +w + +Specifies the widget. + + + + +Composite widgets that allow clients to order their children (usually +homogeneous boxes) can call their widget instance's +XmNinsertPosition +procedure from the class's insert_child procedure to determine +where a new +child should go in its children array. Thus, a client of a composite class +can apply different sorting criteria to widget instances of the class, +passing in a different +XmNinsertPosition +procedure when it creates each +composite widget instance. + +The return value of the +XmNinsertPosition +procedure indicates +how many children +should go before the widget. A value of 0 (zero) indicates that the +widget should go before all other children; returning +the value of XmNumChildren +indicates +that it should go after all other children. +By default, unless a subclass or an application provides an +XmNinsertPosition procedure, each child is inserted at the end +of the XmNchildren list. +The XmNinsertPosition procedure can be overridden by a specific +composite +widget's resource list or by the argument list provided when the composite +widget is created. + + + +Inherited Resources +Composite inherits behavior and resources from the superclass described in +the following table. +For a complete description of each resource, refer to the reference page for +that superclass. + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +1 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for Composite. + + + + +RELATED +&cdeman.Core;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Constrai.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Constrai.sgm new file mode 100644 index 00000000..2171f502 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Constrai.sgm @@ -0,0 +1,278 @@ + + + + + + + + + + + +Constraint +library call + + +Constraint +The Constraint widget class + +Constraint + +widget class +Constraint + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +Constraint widgets +maintain additional state data for each child. For example, +client-defined constraints on the child's geometry may be specified. + +When a constrained composite widget defines constraint resources, all of that +widget's children inherit all of those resources as their own. These +constraint resources are set and read just the same as any other resources +defined for the child. This resource inheritance extends exactly one +generation down, which means only the first-generation children of a +constrained composite widget inherit the parent widget's constraint +resources. + +Because constraint resources are defined by the parent widgets and not +the children, the child widgets never directly use the constraint resource +data. Instead, the parents use constraint resource data to +attach child-specific data to children. + + +Classes +Constraint inherits behavior and resources from Composite +and Core. + +The class pointer is constraintWidgetClass. + +The class name is Constraint. + + + +New Resources +Constraint defines no new resources. + + + +Inherited Resources +Constraint inherits behavior and resources from Composite and Core. +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable +(N/A). + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +1 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for Constraint. + + + + +RELATED +&cdeman.Composite; and &cdeman.Core;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Core.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Core.sgm new file mode 100644 index 00000000..aab1061e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Core.sgm @@ -0,0 +1,460 @@ + + + + + + + + + + + +Core +library call + + +Core +The Core widget class + +Core + +widget class +Core + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +Core is the Xt Intrinsic base class for windowed widgets. The +Object and RectObj classes provide support for windowless +widgets. + + +Classes +All widgets are built from Core. + +The class pointer is widgetClass. + +The class name is Core. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +1 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +XmNaccelerators + +Specifies a translation table that is bound with its actions in the context +of a particular widget. The accelerator table can then be installed on some +destination widget. +Note that the default accelerators for any widget will always be +installed, no matter whether this resource is specified or not. + + + + +XmNancestorSensitive + +Specifies whether the immediate parent of the widget receives input +events. Use the function XtSetSensitive to change the argument +to preserve data integrity (see XmNsensitive). +For shells, the default is copied from the parent's +XmNancestorSensitive resource if there is a parent; otherwise, it +is True. +For other widgets, the default is the bitwise AND of the parent's +XmNsensitive and XmNancestorSensitive resources. + + + + +XmNbackground + +Specifies the background color for the widget. + + + + +XmNbackgroundPixmap + +Specifies a pixmap for tiling the background. The first tile is +placed at the upper left corner of the widget's window. + + + + +XmNborderColor + +Specifies the color of the border in a pixel value. + + + + +XmNborderPixmap + +Specifies a pixmap to be used for tiling the border. The first tile is +placed at the upper left corner of the border. + + + + +XmNborderWidth + +Specifies the width of the border that surrounds the widget's window on all +four sides. The width is specified in pixels. A width of 0 (zero) means that +no border shows. +Note that you should use resources like XmNshadowThickness and +XmNhighlightThickness instead of XmNborderWidth to specify +border widths. + + + + +XmNcolormap + +Specifies the colormap that is used for conversions to the type +Pixel for this widget instance. When this resource +is changed, previously +generated pixel values are not affected, but newly generated +values are in the new colormap. +For shells without parents, the default is the default colormap of the +widget's screen. +Otherwise, the default is copied from the parent. + + + + +XmNdepth + +Specifies the number of bits that can be used for each pixel in the +widget's window. Applications should not change or set the value of this +resource as it is set by the Xt Intrinsics when the widget is created. +For shells without parents, the default is the default depth of the +widget's screen. +Otherwise, the default is copied from the parent. + + + + +XmNdestroyCallback + +Specifies a list of callbacks that is called when the widget +is destroyed. + + + + +XmNheight + +Specifies the inside height (excluding the border) of the widget's +window. + + + + +XmNinitialResourcesPersistent + +Specifies whether or not resources are reference counted. +If the value is True when the widget is created, the resources +referenced by the widget are not reference counted, regardless of how +the resource type converter is registered. +An application that expects to destroy the widget and wants to have +resources deallocated should specify a value of False. +The default is True, implying an assumption that the widget will not be +destroyed during the life of the application. + + + + +XmNmappedWhenManaged + +If this resource is set to True, +it maps the widget (makes it visible) as soon as it is both +realized and managed. +If this resource is set to False, the client is responsible for +mapping and unmapping the widget. If the value is changed from True to +False after the widget has been realized and managed, the widget is +unmapped. + + + + +XmNscreen + +Specifies the screen on which a widget instance resides. +It is read only. +When the Toolkit is initialized, the top-level widget obtains its +default value from the default screen of the display. +Otherwise, the default is copied from the parent. + + + + +XmNsensitive + +Determines whether a widget receives input events. If a widget is +sensitive, the Xt Intrinsics' Event Manager dispatches to the widget all +keyboard, mouse button, motion, window enter/leave, and focus events. +Insensitive widgets do not receive these events. Use the function +XtSetSensitive to change the sensitivity argument. Using +XtSetSensitive ensures that if a parent widget has +XmNsensitive set to False, the ancestor-sensitive flag of all its +children is appropriately set. + + + + +XmNtranslations + +Points to a translations list. A translations list is a list of events and +actions that are to be performed when the events occur. +Note that the default translations for any widget will always be +installed, no matter whether this resource is specified or not. + + + + +XmNwidth + +Specifies the inside width (excluding the border) of the widget's +window. + + + + +XmNx + +Specifies the x-coordinate of the upper left outside corner of the +widget's window. +The value is relative to the upper left inside corner of the parent +window. + + + + +XmNy + +Specifies the y-coordinate of the upper left outside corner of the +widget's window. +The value is relative to the upper left inside corner of the parent +window. + + + + + + + + + + + + + + + + +Translations +There are no translations for Core. + + + + +RELATED +&cdeman.Object; +and +&cdeman.RectObj;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Object.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Object.sgm new file mode 100644 index 00000000..1b78b40b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Object.sgm @@ -0,0 +1,134 @@ + + + + + + + + + + + +Object +library call + + +Object +The Object widget class + +Object + +widget class +Object + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + + +DESCRIPTION +Object is never instantiated. +Its sole purpose is as a supporting superclass for other +widget classes. + + +Classes +The class pointer is objectClass. + +The class name is Object. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +XmNdestroyCallback + +Specifies a list of callbacks that is called when the gadget is destroyed. + + + + + + + + + + + + + + + + +Translations +There are no translation for Object. + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Override.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Override.sgm new file mode 100644 index 00000000..348ea055 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Override.sgm @@ -0,0 +1,390 @@ + + + + + + + + + + + +OverrideShell +library call + + +OverrideShell +The OverrideShell widget class + +OverrideShell + +widget class +OverrideShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +OverrideShell is used for shell windows that completely bypass +the window manager, for example, PopupMenu shells. + + +Classes +OverrideShell inherits behavior and resources from Core, +Composite, and Shell. + +The class pointer is overrideShellWidgetClass. + +The class name is OverrideShell. + + + +New Resources +OverrideShell defines no new resources, but overrides +the XmNoverrideRedirect and XmNsaveUnder resources in the +Shell class. + + + +Inherited Resources +OverrideShell inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +True +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +True +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for OverrideShell. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, and &cdeman.Shell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/RectObj.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/RectObj.sgm new file mode 100644 index 00000000..119902af --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/RectObj.sgm @@ -0,0 +1,282 @@ + + + + + + + + + + + +RectObj +library call + + +RectObj +The RectObj widget class + +RectObj + +widget class +RectObj + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +RectObj is never instantiated. +Its sole purpose is as a supporting superclass for other +widget classes. + + +Classes +RectObj inherits behavior and a resource from Object. + +The class pointer is rectObjClass. + +The class name is RectObj. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +1 +CSG + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +XmNancestorSensitive + +Specifies whether the immediate parent of the +gadget receives input events. +Use the function XtSetSensitive if you are changing the +argument to preserve data integrity (see XmNsensitive). +The default is the bitwise AND of the parent's +XmNsensitive and XmNancestorSensitive resources. + + + + +XmNborderWidth + +Specifies the width of the border placed around the RectObj's rectangular +display area. + + + + +XmNheight + +Specifies the inside height (excluding the border) of the RectObj's +rectangular display area. + + + + +XmNsensitive + +Determines whether a RectObj receives input +events. +If a RectObj is sensitive, the parent dispatches to the +gadget all keyboard, mouse button, motion, window enter/leave, +and focus events. +Insensitive gadgets do not receive these events. +Use the function XtSetSensitive to change the sensitivity argument. +Using XtSetSensitive ensures that if a parent widget has +XmNsensitive set to False, the ancestor-sensitive flag of all its children +is appropriately set. + + + + +XmNwidth + +Specifies the inside width (excluding the border) of the RectObj's +rectangular display area. + + + + +XmNx + +Specifies the x-coordinate of the upper left outside corner of the +RectObj's rectangular display area. +The value is relative to the upper left inside corner of the parent +window. + + + + +XmNy + +Specifies the y-coordinate of the upper left outside corner of the +RectObj's rectangular display area. +The value is relative to the upper left inside corner of the parent +window. + + + + + + +Inherited Resources +RectObj inherits behavior and a resource from Object. For +a description of this resource, refer to the Object reference page. + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + + + +Translations +There are no translations for RectObj. + + + + +RELATED +&cdeman.Object;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Shell.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Shell.sgm new file mode 100644 index 00000000..a33474c3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Shell.sgm @@ -0,0 +1,478 @@ + + + + + + + + + + + +Shell +library call + + +Shell +The Shell widget class + +Shell + +widget class +Shell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +Shell is a top-level widget (with only one managed child) that encapsulates +the interaction with the window manager. + +At the time the shell's child is managed, the child's width is used +for both widgets if the shell is unrealized and no width has been +specified for the shell. Otherwise, the shell's width is used for +both widgets. The same relations hold for the height of the shell and +its child. + + +Classes +Shell inherits behavior and resources from Composite and Core. + +The class pointer is shellWidgetClass. + +The class name is Shell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +False +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + +XmNallowShellResize + +Specifies that if this resource is False, the Shell widget instance +returns XtGeometryNo to all geometry requests from its children. +All Motif convenience create dialog functions override this default +value and set XmNallowShellResize to True. + + + + +XmNcreatePopupChildProc + +Specifies the pointer to a function that is called when the Shell +widget instance is popped up by XtPopup. +The function creates the child widget when the shell is popped up +instead of when the application starts up. +This can be used if the child needs to be reconfigured each time the +shell is popped up. +The function takes one argument, the popup shell, and returns no result. +It is called after the popup callbacks specified by +XmNpopupCallback. + + + + +XmNgeometry + +Specifies the desired geometry for the widget instance. This resource +is examined only when the widget instance is unrealized and the number +of its managed children is changed. It is used to change the values +of the XmNx, XmNy, XmNwidth, and XmNheight +resources. +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. In addition, this resource is not copied on +creation or by XtSetValues. The application must ensure that +the string remains valid until the shell is realized. + + + + +XmNoverrideRedirect + +If True, specifies that the widget instance is a temporary +window that should be ignored by the window manager. Applications and +users should not normally alter this resource. + + + + +XmNpopdownCallback + +Specifies a list of callbacks that is called when the widget instance +is popped down by XtPopdown. + + + + +XmNpopupCallback + +Specifies a list of callbacks that is called when the widget instance +is popped up by XtPopup. +The second argument to XtPopup must be XtGrabNone. + + + + +XmNsaveUnder + +If True, specifies that it is desirable to save the contents of the +screen beneath this widget instance, avoiding expose events when the +instance is unmapped. This is a hint, and an implementation may save +contents whenever it desires, including always or never. + + + + +XmNvisual + +Specifies the visual used in creating the widget. + + + + + + +Inherited Resources +Shell inherits behavior and resources from the +superclass described in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for Shell. + + + + +RELATED +&cdeman.Composite; and &cdeman.Core;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/TopLevel.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/TopLevel.sgm new file mode 100644 index 00000000..3c26fc58 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/TopLevel.sgm @@ -0,0 +1,844 @@ + + + + + + + + + + + +TopLevelShell +library call + + +TopLevelShell +The TopLevelShell widget class + +TopLevelShell + +widget class +TopLevelShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +TopLevelShell is used for normal top-level windows such as any +additional top-level widgets an application needs. + + +Classes +TopLevelShell inherits behavior and resources from Core, +Composite, Shell, +WMShell, and VendorShell. + +The class pointer is topLevelShellWidgetClass. + +The class name is TopLevelShell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +TopLevelShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNiconic +XmCIconic +Boolean +False +CSG + + +XmNiconName +XmCIconName +String +NULL +CSG + + +XmNiconNameEncoding +XmCIconNameEncoding +Atom +dynamic +CSG + + + + + + +XmNiconic + +If True when the widget is created, specifies that the widget +should start as an icon when it is realized. A value of False +indicates that the widget is not to be realized as an icon. This +resource will only override the XmNinitialState resource when +specified in the call that creates the widget. + + + + +XmNiconName + +Specifies the short form of the application name to be displayed by the +window manager when the application is iconified. +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + +XmNiconNameEncoding + +Specifies a property type that represents the encoding of the +XmNiconName string. +If a language procedure has been set, the default is None; otherwise, +the default is XA_STRING. When the widget is realized, if the value +is None, the corresponding name is assumed to be in the current locale. +The name is passed to XmbTextListToTextProperty with an encoding +style of XStdICCTextStyle. The resulting encoding is STRING +if the name is fully convertible to STRING, otherwise COMPOUND_TEXT. +The values of the encoding resources are not changed; they remain None. + + + + + + +Inherited Resources +TopLevelShell inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +VendorShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNaudibleWarning +XmCAudibleWarning +unsigned char +XmBELL +CSG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNdeleteResponse +XmCDeleteResponse +unsigned char +XmDESTROY +CSG + + + +XmNinputMethod +XmCInputMethod +String +NULL +CSG + + +XmNinputPolicy +XmCInputPolicy +XmInputPolicy +XmPER_SHELL +CSG + + +XmNkeyboardFocusPolicy +XmCKeyboardFocusPolicy +unsigned char +XmEXPLICIT +CSG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTabel +XmRenderTable +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + +XmNmwmDecorations +XmCMwmDecorations +int +-1 +CG + + +XmNmwmFunctions +XmCMwmFunctions +int +-1 +CG + + +XmNmwmInputMode +XmCMwmInputMode +int +-1 +CG + + +XmNmwmMenu +XmCMwmMenu +String +NULL +CG + + +XmNpreeditType +XmCPreeditType +String +dynamic +CSG + + +XmNshellUnitType +XmCShellUnitType +unsigned char +XmPIXELS +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +XmPIXELS +CSG + + +XmNuseAsyncGeometry +XmCUseAsyncGeometry +Boolean +False +CSG + + + + + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +True +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +False +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +XmNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +False +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for TopLevelShell. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, &cdeman.Shell;, &cdeman.WMShell;, and +&cdeman.VendorShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Transien.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Transien.sgm new file mode 100644 index 00000000..4abaeafa --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Transien.sgm @@ -0,0 +1,824 @@ + + + + + + + + + + + +TransientShell +library call + + +TransientShell +The TransientShell widget class + +TransientShell + +widget class +TransientShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +TransientShell is used for shell windows that can be manipulated by the +window manager, but are not allowed to be iconified separately. For example, +DialogBoxes make no sense without their associated application. +They are iconified by the window manager only if the main application +shell is iconified. + + +Classes +TransientShell inherits behavior and resources from Core, +Composite, Shell, +WMShell, and VendorShell. + +The class pointer is transientShellWidgetClass. + +The class name is TransientShell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + +In addition to these new resources, TransientShell +overrides the XmNsaveUnder resource in Shell and the +XmNtransient resource in WMShell. + + + + + + + + + + + +TransientShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNtransientFor +XmCTransientFor +Widget +NULL +CSG + + + + + + +XmNtransientFor + +Specifies a widget that the shell acts as a pop-up for. +If this resource is NULL or is a widget that has not been realized, the +XmNwindowGroup is used instead. + + + + + + +Inherited Resources +TransientShell inherits behavior and resources from the superclasses +described in the following tables, +which define sets of widget resources used by the programmer +to specify data. +For a complete description of each resource, refer to the reference +page for that superclass. + +The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +VendorShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNaudibleWarning +XmCAudibleWarning +unsigned char +XmBELL +CSG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNdeleteResponse +XmCDeleteResponse +unsigned char +XmDESTROY +CSG + + + +XmNinputMethod +XmCInputMethod +String +NULL +CSG + + +XmNinputPolicy +XmCInputPolicy +XmInputPolicy +XmPER_SHELL +CSG + + +XmNkeyboardFocusPolicy +XmCKeyboardFocusPolicy +unsigned char +XmEXPLICIT +CSG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTabel +XmRenderTable +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + +XmNmwmDecorations +XmCMwmDecorations +int +-1 +CG + + +XmNmwmFunctions +XmCMwmFunctions +int +-1 +CG + + +XmNmwmInputMode +XmCMwmInputMode +int +-1 +CG + + +XmNmwmMenu +XmCMwmMenu +String +NULL +CG + + +XmNpreeditType +XmCPreeditType +String +dynamic +CSG + + +XmNshellUnitType +XmCShellUnitType +unsigned char +XmPIXELS +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +XmPIXELS +CSG + + +XmNuseAsyncGeometry +XmCUseAsyncGeometry +Boolean +False +CSG + + + + + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +True +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +True +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +XmNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +True +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for TransientShell. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Core;, &cdeman.Shell;, &cdeman.VendorShell;, and &cdeman.WMShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Uil.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Uil.sgm new file mode 100644 index 00000000..4a9cc750 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Uil.sgm @@ -0,0 +1,419 @@ + + + + + + + + + + + +Uil +library call + + +Uil +Invokes the UIL compiler from within an application + +Uil + +uil functions +Uil + +uil compiler + + + + + + + + + + + + + + + + + + + + + + + + +#include <uil/UilDef.h> + +Uil_status_type Uil + +Uil_command_type *command_desc +Uil_compile_desc_type **compile_desc +Uil_continue_type (*message_cb) () +char *message_data +Uil_continue_type (*status_cb) () +char *status_data + + + +DESCRIPTION +The Uil function provides a callable entry point for the UIL +compiler. The +Uil callable interface can be used to process +a UIL source file and to +generate UID files, as well as return a detailed description of the +UIL source module in the form of a symbol table (parse tree). + + + +command_desc + +Specifies the uil command line. + + + + +compile_desc + +Returns the results of the compilation. + + + + +message_cb + +Specifies a callback function that is called when the compiler +encounters errors in the UIL source. + + + + +message_data + +Specifies user data that is passed to the message callback function +(message_cb). Note that this argument is not interpreted by UIL, and is +used exclusively by the calling application. + + + + +status_cb + +Specifies a callback function that is called to allow X applications to service +X events such as updating the screen. This function is called +at various check points, which have been hard coded into the UIL compiler. +The status_update_delay argument in command_desc +specifies the number of +check points to be passed before the status_cb function is invoked. + + + + +status_data + +Specifies user data that is passed to the status callback function +(status_cb). +Note that this argument is not interpreted by the UIL compiler +and is used exclusively by the calling application. + + + + +Following are the data structures Uil_command_type and +Uil_compile_desc_type: + + +typedef struct Uil_command_type { +char *source_file; + /* single source to compile */ +char *resource_file; /* name of output file */ +char *listing_file; /* name of listing file */ +unsigned int *include_dir_count; + /* number of dirs. in include_dir */ +char *((*include_dir) []); + /* dir. to search for include files */ +unsigned listing_file_flag: 1; + /* produce a listing */ +unsigned resource_file_flag: 1; + /* generate UID output */ +unsigned machine_code_flag: 1; + /* generate machine code */ +unsigned report_info_msg_flag: 1; + /* report info messages */ +unsigned report_warn_msg_flag: 1; + /* report warnings */ +unsigned parse_tree_flag: 1; + /* generate parse tree */ +unsigned int status_update_delay; + /* number of times a status point is */ + /* passed before calling status_cb */ + /* function 0 means called every time */ +char *database; + /* name of database file */ +unsigned database_flag: 1; + /* read a new database file */ +unsigned use_setlocale_flag: 1; + /* enable calls to setlocale */ +}; +typedef struct Uil_compile_desc_type { +unsigned int compiler_version; + /* version number of compiler */ +unsigned int data_version; + /* version number of structures */ +char *parse_tree_root; /* parse tree output */ +unsigned int message_count [Uil_k_max_status+1]; +/* array of severity counts */ +}; + + +Following is a description of the message callback function specified by +message_cb: + +Uil_continue_type (*message_cb) (message_data, message_number, severity, msg_buffer, +src_buffer, ptr_buffer, loc_buffer, message_count) + char *message_data; + int message_number; + int severity; + char *msg_buffer, *src_buffer; + char *ptr_buffer, *loc_buffer; + int message_count[]; +This function specifies a callback function that UIL +invokes instead of printing an +error message when the compiler encounters an error in the UIL source. +The callback should return one of the following values: + + + +Uil_k_terminate + +Terminate processing of the source file + + + + +Uil_k_continue + +Continue processing the source file + + + + +The arguments are + + + +message_data + +Data supplied by the application as the message_data argument to +the Uil function. +UIL does not interpret this data in any way; it just passes it to the +callback. + + + + +message_number + +An index into a table of error messages and severities for internal use +by UIL. + + + + +severity + +An integer that indicates the severity of the error. +The possible values are the status constants returned by the Uil +function. +See Return Value for more information. + + + + +msg_buffer + +A string that describes the error. + + + + +src_buffer + +A string consisting of the source line where the error occurred. +This string is not always available. In this case, the argument is NULL. + + + + +ptr_buffer + +A string consisting of whitespace and a printing character in the +character position corresponding to the column of the source line where +the error occurred. +This string may be printed beneath the source line to provide a visual +indication of the column where the error occurred. +This string is not always available. In this case, the argument is NULL. + + + + +loc_buffer + +A string identifying the line number and file of the source line where +the error occurred. +This is not always available; the argument is then NULL. + + + + +message_count + +An array of integers containing the number of diagnostic messages issued +thus far for each severity level. +To find the number of messages issued for the current severity level, +use the severity argument as the index into this array. + + + + +Following is a description of the status callback function specified by +status_cb: + +Uil_continue_type (*status_cb) (status_data, percent_complete, + lines_processed, current_file, message_count) + char *status_data; + int percent_complete; + int lines_processed; + char *current_file; + int message_count[]; +This function specifies a callback function that is +invoked to allow X applications to +service X events such as updating the screen. +The callback should return one of the following values: + + + +Uil_k_terminate + +Terminate processing of the source file + + + + +Uil_k_continue + +Continue processing the source file + + + + +The arguments are + + + +status_data + +Data supplied by the application as the status_data argument to +the Uil function. +UIL does not interpret this data in any way; it just passes it to the +callback. + + + + +percent_complete + +An integer indicating what percentage of the current source file has +been processed so far. + + + + +lines_processed + +An integer indicating how many lines of the current source file have +been read so far. + + + + +current_file + +A string containing the pathname of the current source file. + + + + +message_count + +An array of integers containing the number of diagnostic messages issued +thus far for each severity level. +To find the number of messages issued for a given severity level, use +the severity level as the index into this array. +The possible severity levels +are the status constants returned by the +Uil function. +See Return Value for more information. + + + + + + +RETURN +This function returns one of the following +status return constants: + + + +Uil_k_success_status + +The operation succeeded. + + + + +Uil_k_info_status + +The operation succeeded. An informational +message is returned. + + + + +Uil_k_warning_status + +The operation succeeded. A warning +message is returned. + + + + +Uil_k_error_status + +The operation failed due to an error. + + + + +Uil_k_severe_status + +The operation failed due to an error. + + + + + + +RELATED +&cdeman.UilDumpSymbolTable; and +&cdeman.uil;. + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/UilDumpS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/UilDumpS.sgm new file mode 100644 index 00000000..7158c6a0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/UilDumpS.sgm @@ -0,0 +1,136 @@ + + + + + + + + + + + +UilDumpSymbolTable +library call + + +UilDumpSymbolTable +Dumps the contents of a named UIL symbol table to standard output + +UilDumpSymbolTable + +uil functions +UilDumpSymbolTable + + + + + + + + + + + + + + + + + + + + + + + + +#include <uil/UilDef.h> + +void UilDumpSymbolTable + +sym_entry_type *root_ptr + + + +DESCRIPTION +The UilDumpSymbolTable function dumps +the contents of a +UIL symbol table pointer to standard output. + + + +root_ptr + +Specifies a pointer to the the symbol table root entry. +This value can be taken from the parse_tree_root part of +the Uil_compile_desc_type data structure returned by Uil. + + + + +By following the link from the root entry, +you can traverse the entire parse tree. +Symbol table entries are in the following format: + +hex.address +symbol.type +symbol.data +prev.source.position +source.position +modification.record + +where: + + + +hex.address + +Specifies the hexadecimal address of this entry in the symbol table. + + + + +symbol.type + +Specifies the type of this symbol table entry. Some possible types +are root, module, value, procedure, and widget. + + + + +symbol.data + +Specifies data for the symbol table entry. The data varies with the +type of the entry. Often it contains pointers to other symbol table entries, +or the actual data for the data type. + + + + +prev.source.position + +Specifies the end point in the source code for the previous source item. + + + + +source.position + +Specifies the range of positions in the source code for this symbol. + + + + +The exact data structures for each symbol type are defined in the +include file UilSymDef.h. +Note that this file is automatically included when +an application includes the file UilDef.h. + + + +RELATED +&cdeman.Uil3; + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/Vendor.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/Vendor.sgm new file mode 100644 index 00000000..236dc88d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/Vendor.sgm @@ -0,0 +1,1424 @@ + + + + + + + + + + + +VendorShell +library call + + +VendorShell +The VendorShell widget class + +VendorShell + +widget class +VendorShell + + + +#include <Xm/Xm.h> +#include <X11/Shell.h> + + + +DESCRIPTION +VendorShell is a Motif widget class used as a supporting superclass for +all shell classes that are visible to the window manager and that are +not override redirect. +It contains resources that describe the MWM-specific look and feel. +It also manages the MWM-specific communication needed by all VendorShell +subclasses. +See the mwm reference page for more information. + +If an application uses the XmNmwmDecorations, +XmNmwmFunctions, or XmNmwmInputMode resource, it should +include the file Xm/MwmUtil.h. + +Setting XmNheight, XmNwidth, or XmNborderWidth for +either a VendorShell or its managed child usually sets that resource to the +same value in both the parent and the child. When an off-the-spot input +method exists, the height and width of the shell may be greater than +those of the managed child in order to accommodate the input method. +In this case, setting XmNheight or XmNwidth for the +shell does not necessarily set that resource to the same value in +the managed child, and setting XmNheight or XmNwidth +for the child does not necessarily set that resource to the same +value in the shell. + +For the managed child of a VendorShell, regardless of the value +of the shell's XmNallowShellResize, setting XmNx or +XmNy sets the corresponding resource of the parent but does +not change the child's position relative to the parent. +XtGetValues for the child's XmNx or XmNy yields the +value of the corresponding resource in the parent. +The x and y-coordinates of the child's upper left outside +corner relative to the parent's upper left inside corner are both 0 (zero) +minus the value of XmNborderWidth. + +Note that the Inter-Client Communication Conventions Manual (ICCCM) +allows a window manager to change or control the border width of a reparented +top-level window. + +VendorShell holds the XmQTspecifyRenderTable trait. + + +Classes +VendorShell inherits behavior, resources, and traits from the Core, +Composite, Shell, and +WMShell classes. + +The class pointer is vendorShellWidgetClass. + +The class name is VendorShell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +subresource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a subresource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given subresource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +VendorShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNaudibleWarning +XmCAudibleWarning +unsigned char +XmBELL +CSG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNdeleteResponse +XmCDeleteResponse +unsigned char +XmDESTROY +CSG + + +XmNinputMethod +XmCInputMethod +string +NULL +CSG + + +XmNinputPolicy +XmCInputPolicy +XmInputPolicy +XmPER_SHELL +CSG + + +XmNkeyboardFocusPolicy +XmCKeyboardFocusPolicy +unsigned char +XmEXPLICIT +CSG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTabel +XmRenderTable +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + +XmNmwmDecorations +XmCMwmDecorations +int +-1 +CG + + +XmNmwmFunctions +XmCMwmFunctions +int +-1 +CG + + +XmNmwmInputMode +XmCMwmInputMode +int +-1 +CG + + +XmNmwmMenu +XmCMwmMenu +String +NULL +CG + + +XmNpreeditType +XmCPreeditType +String +dynamic +CSG + + +XmNverifyPreedit +XmCVerifyPreedit +Boolean +False +CSG + + +XmNshellUnitType +XmCShellUnitType +unsigned char +XmPIXELS +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +XmPIXELS +CSG + + +XmNuseAsyncGeometry +XmCUseAsyncGeometry +Boolean +False +CSG + + + + + + +XmNaudibleWarning + +Determines whether an action activates its associated audible cue. +The possible values are XmBELL and XmNONE. + + + + +XmNbuttonFontList + +Specifies the font list used for button descendants. See the +XmNbuttonRenderTable resource. + + + + +XmNbuttonRenderTable + +Specifies the render table used for VendorShell's button descendants. +If this value is NULL at initialization and if the value of +XmNdefaultFontList is not NULL, XmNbuttonRenderTable +is initialized to the value of XmNdefaultFontList. If +the value of XmNdefaultFontList is NULL, +the parent hierarchy of the widget is searched for +an ancestor that holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, +XmNbuttonRenderTable is initialized to the +XmBUTTON_RENDER_TABLE value +of the ancestor widget. If no such ancestor is found, the default +is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNdefaultFontList + +Specifies a default font list for VendorShell's descendants. +This resource is obsolete and exists for compatibility with +earlier releases. It has been replaced by XmNbuttonFontList, +XmNlabelFontList, and XmNtextFontList. + + + + +XmNdeleteResponse + +Determines what action the shell takes in response to a +WM_DELETE_WINDOW message. +The setting can be one of three values: XmDESTROY, XmUNMAP, +and XmDO_NOTHING. +The resource is scanned, and the appropriate action is taken after the +WM_DELETE_WINDOW callback list (if any) that is registered with +the Protocol manager has been called. + + + + +XmNinputMethod + +Specifies the string that sets the locale modifier for the input +method. +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + +XmNinputPolicy + +Specifies the policy to follow for creating an +Input Context (IC) for this shell. This resource can have the +following values: + + + +XmPER_SHELL + +Specifies that only one XIC is created per shell. + + + + +XmPER_WIDGET + +Specifies that one XIC is created for each widget. + + + + + + + +XmNkeyboardFocusPolicy + +Determines allocation of keyboard focus within the widget hierarchy rooted +at this shell. The X keyboard focus must be directed to somewhere in the +hierarchy for this client-side focus management to take effect. +Possible values are XmEXPLICIT, specifying a click-to-type policy, +and XmPOINTER, specifying a pointer-driven policy. + + + + +XmNlabelFontList + +Specifies the font list used for label descendants. See the +XmNlabelRenderTable resource. + + + + +XmNlabelRenderTable + +Specifies the font list used for VendorShell's label descendants +(Labels and LabelGadgets). If this value is NULL at initialization +and if the value of XmNdefaultFontList is not NULL, +XmNlabelFontList is initialized to the value of +XmNdefaultFontList. If the value of XmNdefaultFontList is +NULL, the parent hierarchy of the widget is searched +for an ancestor that holds the XmQTspecifyRenderTable trait. +If such +an ancestor is found, XmNlabelRenderTable is initialized to the +XmLABEL_RENDER_TABLE of the ancestor widget. If no such ancestor +is found, the default is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNlayoutDirection + +Specifies the direction in which the subwidgets, children of a +widget, or other visual components are to be laid out. This policy +will apply as the default layout policy for all descendants of this +VendorShell. + + + + +XmNmwmDecorations + +Specifies the decoration flags (specific decorations to add or remove +from the window manager frame) for the _MOTIF_WM_HINTS property. +If any decoration flags are specified by the _MOTIF_WM_HINTS +property, only decorations indicated by both that property and the MWM +clientDecoration and transientDecoration resources are displayed. +If no decoration flags are specified by the _MOTIF_WM_HINTS property, +decorations indicated by the MWM clientDecoration and +transientDecoration resources are displayed. +The default for the XmNmwmDecorations resource +is not to specify any decoration flags for the _MOTIF_WM_HINTS property. + +The value of this resource is the bitwise inclusive OR of one or more +flag bits. +The possible flag bit constants, defined in the include +file Xm/MwmUtil.h, are + + + +MWM_DECOR_ALL + +All decorations except those specified by +other flag bits that are set + + + + +MWM_DECOR_BORDER + +Client window border + + + + +MWM_DECOR_RESIZEH + +Resize frame handles + + + + +MWM_DECOR_TITLE + +Title bar + + + + +MWM_DECOR_MENU + +Window menu button + + + + +MWM_DECOR_MINIMIZE + +Minimize window button + + + + +MWM_DECOR_MAXIMIZE + +Maximize window button + + + + + + + +XmNmwmFunctions + +Specifies the function flags (specific window manager functions to +apply or not apply to the client window) for the _MOTIF_WM_HINTS +property. +If any function flags are specified by the _MOTIF_WM_HINTS +property, only functions indicated by both that property and the MWM +clientFunctions and transientFunctions resources are +applied. +If no function flags are specified by the _MOTIF_WM_HINTS +property, functions indicated by the MWM clientFunctions and +transientFunctions resources are applied. +The default for the XmNmwmFunctions resource is not to specify any +function flags for the _MOTIF_WM_HINTS property. + +The value of this resource is the bitwise inclusive OR of one or more +flag bits. +The possible flag bit constants, defined in the include +file Xm/MwmUtil.h, are + + + +MWM_FUNC_ALL + +All functions except those specified by +other flag bits that are set + + + + +MWM_FUNC_RESIZE + +f.resize + + + + +MWM_FUNC_MOVE + +f.move + + + + +MWM_FUNC_MINIMIZE + +f.minimize + + + + +MWM_FUNC_MAXIMIZE + +f.maximize + + + + +MWM_FUNC_CLOSE + +f.kill + + + + + + + +XmNmwmInputMode + +Specifies the input mode flag (application modal or system modal input +constraints) for the _MOTIF_WM_HINTS property. +If no input mode flag is specified by the _MOTIF_WM_HINTS +property, no input constraints are applied, and input goes to any +window. +The default for the XmNmwmInputMode resource is not to specify any +input mode flag for the _MOTIF_WM_HINTS property. + +An application that sets input constraints on a dialog usually uses the +BulletinBoard's XmNdialogStyle resource rather than the parent +DialogShell's XmNmwmInputMode resource. + +The possible values for this resource, defined in the +include file Xm/MwmUtil.h, are + + + +MWM_INPUT_MODELESS + +Input goes to any window. + + + + +MWM_INPUT_PRIMARY_APPLICATION_MODAL + +Input does not +go to ancestors of this window. + + + + +MWM_INPUT_SYSTEM_MODAL + +Input goes only to this window. + + + + +MWM_INPUT_FULL_APPLICATION_MODAL + +Input does not go to other +windows in this application. + + + + + + + +XmNmwmMenu + +Specifies the menu items that the Motif window manager should add to the end +of the window menu. The string contains a list of items separated +by \n with the following format: + +label [mnemonic] [accelerator] function + +If more than one item is specified, the items should be separated by a +newline character. + +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + +XmNpreeditType + +Specifies the input method style or styles available to the input +manager. The resource can be a comma-separated list of the following +values: + + + + + + + +Preedit Values + + +Preedit Value +XIM Style + + +OffTheSpot +XIMPreeditArea + + +Root +XIMPreeditNothing + + +None +XIMPreeditNone + + +OverTheSpot +XIMPreeditPosition + + +OnTheSpot +XIMPreeditCallbacks + + + + +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + +XmNshellUnitType + +This resource is obsolete, and is included only for compatibility with +earlier releases of Motif. Use the XmNunitType resource +instead. + + + + +XmNtextFontList + +Specifies the font list used for text descendants. See the +XmNtextRenderTable resource. + + + + +XmNtextRenderTable + +Specifies the render table used for VendorShell's Text and List +descendants. If this value is NULL at initialization +and if the value of XmNdefaultFontList is not NULL, +XmNtextRenderTable is initialized to the value of +XmNdefaultFontList. If the value of XmNdefaultFontList is +NULL, the parent hierarchy of the widget is searched +for an ancestor that holds the XmQTspecifyRenderTable trait. +If such +an ancestor is found, XmNtextRenderTable is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such ancestor +is found, the default is implementation dependent. +Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNunitType + +Provides the basic support for resolution independence. It defines +the type of units a widget uses with sizing and positioning resources. +The resource has a default unit type of XmPIXELS. + +The unit type can also be specified in resource files, with the +following format: + + +<floating value><unit> + + +where: + + + +unit + +is <" ", pixels, inches, centimeters, millimeters, points, font units> + + + + +pixels + +is <pix, pixel, pixels> + + + + +inches + +is <in, inch, inches> + + + + +centimeter + +is <cm, centimeter, centimeters> + + + + +millimeters + +is <mm, millimeter, millimeters> + + + + +points + +is <pt, point, points> + + + + +font units + +is <fu, font_unit, font_units> + + + + +float + +is {"+"|"-"}{{<"0"-"9">*}.}<"0"-"9">* + +Note that the type Dimension must always be positive. + + + + +For example, + + +xmfonts*XmMainWindow.height: 10.4cm +*PostIn.width: 3inches + + +XmNunitType can have the following values: + + + +XmPIXELS + +All values provided to the widget are treated as normal +pixel values. + + + + +XmMILLIMETERS + +All values provided to the widget are treated as normal millimeter +values. + + + + +Xm100TH_MILLIMETERS + +All values provided to the widget are treated +as 1/100 of a millimeter. + + + + +XmCENTIMETERS + +All values provided to the widget are treated as normal centimeter +values. + + + + +XmINCHES + +All values provided to the widget are treated as normal inch +values. + + + + +Xm1000TH_INCHES + +All values provided to the widget are treated as +1/1000 of an inch. + + + + +XmPOINTS + +All values provided to the widget are treated as normal point +values. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +All values provided to the widget are treated as +1/100 of a point. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as normal font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. These are the +values of the XmScreen resources XmNhorizontalFontUnit and +XmNverticalFontUnit. + + + + +For more information about units, refer to the XmConvertUnits +reference page. + + + + +XmNuseAsyncGeometry + +Specifies whether the geometry manager should wait for confirmation of a +geometry request to the window manager. +When the value of this resource is True, the geometry manager forces +XmNwaitForWm to False and XmNwmTimeout to 0, and it relies +on asynchronous notification. +When the value of this resource is False, XmNwaitForWm and +XmNwmTimeout are unaffected. +The default is False. + + + + + + +Inherited Resources +VendorShell inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +True +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +False +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +mNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +False +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Translations +There are no translations for VendorShell. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Core;, +&cdeman.mwm;, +&cdeman.Shell;, +&cdeman.WMShell;, +&cdeman.XmActivateProtocol;, +&cdeman.XmActivateWMProtocol;, +&cdeman.XmAddProtocolCallback;, +&cdeman.XmAddWMProtocolCallback;, +&cdeman.XmAddProtocols;, +&cdeman.XmAddWMProtocols;, +&cdeman.XmDeactivateProtocol;, +&cdeman.XmDeactivateWMProtocol;, +&cdeman.XmGetAtomName;, +&cdeman.XmInternAtom;, +&cdeman.XmIsMotifWMRunning;, +&cdeman.XmRemoveProtocolCallback;, +&cdeman.XmRemoveWMProtocolCallback;, +&cdeman.XmRemoveProtocols;, +&cdeman.XmRemoveWMProtocols;, +&cdeman.XmScreen;, +&cdeman.XmSetProtocolHooks;, +and &cdeman.XmSetWMProtocolHooks;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/VirtBind.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/VirtBind.sgm new file mode 100644 index 00000000..ae7588c3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/VirtBind.sgm @@ -0,0 +1,817 @@ + + + + + + + + + + + +VirtualBindings +library call + + +VirtualBindings +Bindings for virtual mouse and key events + +VirtualBindings + +default bindings +VirtualBindings + + + + + + + + + + + + + + + + + + + + + + + +DESCRIPTION +The Motif reference pages describe key translations in terms of +virtual bindings, based on those described in the &MotifStyleGd;. + + +Bindings for osf Keysyms +Keysym strings that begin with osf are not part of the X server's +keyboard mapping. +Instead, these keysyms are produced on the client side at run time. +They are interpreted by the routine XmTranslateKey, and +are used by the translation manager when the server delivers an actual +key event. +For each application, a mapping is maintained between osf keysyms and +keysyms that correspond to actual keys. +This mapping is based on information obtained at application startup +from one of the following sources, listed in order of precedence: + + + +The XmNdefaultVirtualBindings resource from Display. + + + +A property on the root window, which can be set by mwm on startup, +or by the xmbind client, or on prior startup of a Motif +application. + + + +The file .motifbind in the user's home directory. + + + +A set of bindings based on the vendor string and optionally the vendor +release of the X server. +Motif searches for these bindings in the following steps: + + + +If the file xmbind.alias exists in the user's home directory, +Motif searches this file for a pathname associated with the vendor +string or with the vendor string and vendor release. +If it finds such a pathname and if that file exists, Motif loads the +bindings contained in that file. + + + +If it has found no bindings, Motif next looks for the file +xmbind.alias in the directory specified by the environment +variable XMBINDDIR, if XMBINDDIR is set, or in the directory +/usr/lib/Xm/bindings if XMBINDDIR is not set. +If this file exists Motif searches it for a pathname associated with the +vendor string or with the vendor string and vendor release. +If it finds such a pathname and if that file exists, Motif loads the +bindings contained in that file. + + + +If it still has found no bindings, Motif loads a set of hard-coded +fallback bindings. + + + + + +The xmbind.alias file contains zero or more lines of the following form: + +"vendor_string[ vendor_release]" bindings_file + +where vendor_string is the X server vendor name as returned by the +X client xdpyinfo or the Xlib function XServerVendor, and +must appear in double quotes. +If vendor_release is included, it is the X server vendor release +number as returned by the X client xdpyinfo or the Xlib function +XVendorRelease, and must also be contained within the double +quotes separated by one space from vendor_string. +The vendor_release argument is provided to allow support +of changes in keyboard +hardware from a vendor, assuming that the vendor increments the release +number to flag such changes. +Alternatively, the vendor may simply use a unique vendor string for each +different keyboard. + +The bindings_file argument is the pathname of +the file containing the bindings +themselves. +It can be a relative or absolute pathname. +If it it is a relative pathname, it is relative to the location of the +xmbind.alias file. + +Comment lines in the xmbind.alias file begin with ! (exclamation +point). + +The bindings found in either the .motifbind file or the vendor +mapping are placed in a property on the root window. +This property is used to determine the bindings for subsequent Motif +applications. + +On startup mwm attempts to load the file .motifbind in the +user's home directory. +If this is unsuccessful, it loads the vendor bindings as described +previously. +It places the bindings it loads in a property on the root window for use +by subsequent Motif applications. + +The xmbind function loads bindings +from a file if that file is specified on the +command line. +If no file is specified on the command line, it attempts to load the +file .motifbind in the user's home directory. +If this fails, it loads the vendor bindings as described previously. +It places the bindings it loads in a property on the root window for use +by subsequent Motif applications. + +The format of the specification for mapping osf keysyms to +actual keysyms is similar to that of a specification for an event +translation. (See below) The syntax is specified (and below) here in +EBNF notation using the following conventions: + +[a] Means either nothing or a +{a} Means zero or more occurrences of a +(a|b) Means either a or b. + +Terminals are enclosed in double quotation marks. + +The syntax of an osf keysym binding specification is as follows: + +binding_spec = {line "\n"} [line] +line = virtual_keysym ":" list_of_key_event +list_of_key_event= key_event { "," key_event} +key_event = {modifier_name} "<Key>" actual_keysym +virtual_keysym = keysym +actual_keysym = keysym +keysym = A valid X11 keysym name that is + mapped by XStringToKeysym + +As with event translations, more specific event descriptions must +precede less specific descriptions. +For example, an event description for a key with a modifier must precede +a description for the same key without the same modifier. + +Following is an example of a specification for the +defaultVirtualBindings resource in a resource file: + + +*defaultVirtualBindings: \ + osfBackSpace: <Key>BackSpace \n\ + osfInsert: <Key>InsertChar \n\ + osfDelete: <Key>DeleteChar \n\ +&npzwc;... + osfLeft: <Key>left, Ctrl<Key>H + + + +The format of a .motifbind file or of a file containing vendor +bindings is the same, except that the binding specification for each +keysym is placed on a separate line. +The previous example specification appears as follows in a +.motifbind or vendor bindings file: + + +osfBackSpace: <Key>BackSpace +osfInsert: <Key>InsertChar +osfDelete: <Key>DeleteChar +&npzwc;... +osfLeft: <Key>left, Ctrl<Key>H + + + +The following table lists the fixed fallback default bindings for +osf keysyms. + + + + + + + +Fallback Default Bindings for osf Keysyms + + +osf Keysym +Fallback Default Binding + + +osfActivate: +KeyKP_Enter +KeyExecute + + +osfAddMode: +Shift<Key>F8 + + +osfBackSpace: +KeyBackSpace + + +osfBeginLine: +KeyHome +KeyBegin + + +osfCancel: +KeyEscape +KeyCancel + + +osfClear: +KeyClear + + +osfCopy: +unbound + + +osfCut: +unbound + + +osfDelete: +KeyDelete + + +osfDeselectAll: +unbound + + +osfDown: +KeyDown + + +osfEndLine: +KeyEnd + + +osfHelp: +KeyF1 +KeyHelp + + +osfInsert: +KeyInsert + + +osfLeft: +KeyLeft + + +osfLeftLine: +unbound + + +osfMenu: +ShiftKeyF10 +KeyMenu + + +osfMenuBar: +KeyF10 +ShiftKeyMenu + + +osfNextMinor: +unbound + + +osfPageDown: +KeyNext + + +osfPageLeft: +unbound + + +osfPageRight: +unbound + + +osfPageUp: +KeyPrior + + +osfPaste: +unbound + + +osfPrimaryPaste: +unbound + + +osfPriorMinor: +unbound + + +osfReselect: +unbound + + +osfRestore: +unbound + + +osfRight: +KeyRight + + +osfRightLine: +unbound + + +osfSelect: +KeySelect + + +osfSelectAll: +unbound + + +osfSwitchDirection: +AltKeyReturn +AltKeyKP_Enter + + +osfUndo: +KeyUndo + + +osfUp: +KeyUp + + + + + + + +Changes in the Handling of Shifted Keys +In conjunction with MIT X11R5 Patch 24, this version of Motif +introduces a change in the way that keys involving the <Shift> +modifier are processed. This change allows the numeric keypad to be +used to generate numbers using the standard X mechanisms. Since the +default behavior is now to honor the xmodmap keymap bindings, +translations and virtual key bindings that use <Shift> may behave +differently. A common symptom is that unshifted keypad and function +keys (with or without other modifiers) produce the expected results, +but shifted ones do not. + +To obtain the old behavior you can remove the shifted interpretation +from problematic keys using the xmodmap utility. Each entry in +a xmodmap keymap table contains up to four keysym bindings. The +second and fourth keysyms are for shifted keys. If an expression +contains only two keysyms, simply remove the second keysym. If +an entry contains three or more keysyms, replace the second keysym +with NoSymbol and remove the fourth keysym. + + + +Action Translations +The translation table syntax used by Motif is completely specified +in the X11R5 Toolkit Intrinsics Documentation. For the complete syntax +description, and for general instructions about writing or modifying a +translation table, please refer to this document. A brief summary of the +translation table format, however, is included below. + +The syntax is defined as in the binding syntax specification above. +Informal descriptions are contained in angle brackets (<>). +TranslationTable= [ directive ] { production } +directive = ( "#replace" | "#override" | "#augment") "\n" +production = lhs ":" rhs "\n" +lhs = ( event | keyseq) {"," ( event | keyseq) } +keyseq = """ keychar { keychar } """ +keychar = ( "⁁" | "$" | "\\") <ISO Latin 1 character> +event = [ modifier_list ] "<" event_type ">" [ count ] {detail} +modifier_list = ( ["!"][":"] { modifier } | "None") +modifier = [ "~" ] ( "@" <keysym> | <name from table below>) +count = "(" <positive integer> [ "+" ] ")" +rhs = { action_name "(" [params] ")" } +params = string { "," string } + +The string field need not be quoted unless it includes a space +or tab character, or any comma, newline, or parenthesis. The entire +list of string values making up the params field will ba passed +to the named action routine. + +The details field may be used to specify a keysym that will +identify a particular key event. For example, Key is the name +of a type of event, but it must be modified by the details field +to name a specific event, such as KeyA. + +Modifier Names +The modifier list, which may be empty, consists of a list of modifier +keys that must be pressed with the key sequence. The modifier keys +may abbreviated with single letters, as in the following list of the +familiar modifiers: + + + +s + +Shift + + + + +c or ⁁ + +Ctrl (Control) + + + + +m or $ + +Meta + + + + +a + +Alt + + + + +Other modifiers are available, such as "Mod5" and "Button2." These +have no abbreviation (although the "Button" modifiers may be +abbreviated in combination with events, as outlined below). If a +modifier list has no entries, and is not "None", it means the position +of the modifier keys is irrelevant. If modifiers are listed, the +designated keys must be in the specified position, but the unlisted +modifier keys are irrelevant. If the list begins with an exclamation +point (!), however, the unlisted modifiers may not be asserted. In +addition, if a modifier name is preceded by a tilde (~), the +corresponding key must not be pressed. + +If a modifier list begins with a colon (:), X tries to use the +standard modifiers (Shift and Lock), if present, to map the key event +code into a recognized keysym. + +Event Types +These are a few of the recognized event types. + + + +Key or KeyDown + +A keyboard key was pressed. + + + + +KeyUp + +A keyboard key was released. + + + + +BtnDown + +A mouse button was pressed. + + + + +BtnUp + +A mouse button was released. + + + + +Motion + +The mouse pointer moved. + + + + +Enter + +The pointer entered the widget's window. + + + + +Leave + +The pointer left the widget's window. + + + + +FocusIn + +The widget has received focus. + + + + +FocusOut + +The widget has lost focus. + + + + +There are some event abbreviations available. For example, +Btn1Motion is actually a "Motion" event, modified with the +"Button1" modifier (Button1<Motion>). Similarly, Btn3Up +is actually a "BtnUp" event with the "Button3" modifier. These +abbreviations are used extensively in the Motif translation +tables. + + + + +RELATED +&cdeman.xmbind; + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X/WMShell.sgm b/cde/imports/motif/doc/C/guides/man/PR3X/WMShell.sgm new file mode 100644 index 00000000..71938aca --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X/WMShell.sgm @@ -0,0 +1,906 @@ + + + + + + + + + + + +WMShell +library call + + +WMShell +The WMShell widget class + +WMShell + +widget class +WMShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +&npzwc;#include <X11/Shell.h> + + + +DESCRIPTION +WMShell is a top-level widget that encapsulates the interaction with the +window manager. + + +Classes +WMShell inherits behavior and resources from the Core, Composite, +and Shell classes. + +The class pointer is wmShellWidgetClass. + +The class name is WMShell. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +False +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +False +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +XmNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + +XmNbaseHeight + +Specifies the base for a progression of preferred heights for the +window manager to use in sizing the widget. +The preferred heights are XmNbaseHeight plus integral multiples of +XmNheightInc, with a minimum of XmNminHeight and a maximum +of XmNmaxHeight. +If an initial value is not supplied for XmNbaseHeight but is +supplied for XmNbaseWidth, the value of XmNbaseHeight +is set to 0 (zero) when the widget is realized. + + + + +XmNbaseWidth + +Specifies the base for a progression of preferred widths for the +window manager to use in sizing the widget. +The preferred widths are XmNbaseWidth plus integral multiples of +XmNwidthInc, with a minimum of XmNminWidth and a maximum of +XmNmaxWidth. +If an initial value is not supplied for XmNbaseWidth but is +supplied for XmNbaseHeight, the value of XmNbaseWidth +is set to 0 (zero) when the widget is realized. + + + + +XmNheightInc + +Specifies the increment for a progression of preferred heights for the +window manager to use in sizing the widget. +The preferred heights are XmNbaseHeight plus integral multiples of +XmNheightInc, with a minimum of XmNminHeight and a maximum +of XmNmaxHeight. +If an initial value is not supplied for XmNheightInc but is +supplied for XmNwidthInc, the value of XmNheightInc +is set to 1 when the widget is realized. + + + + +XmNiconMask + +Specifies a bitmap that could be used by the window manager to clip the +XmNiconPixmap bitmap to make the icon nonrectangular. + + + + +XmNiconPixmap + +Specifies a bitmap that could be used by the window manager as the +application's icon. + + + + +XmNiconWindow + +Specifies the ID of a window that could be used by the window manager +as the application's icon. + + + + +XmNiconX + +Specifies a suitable place to put the application's icon; this is a hint +to the window manager in root window coordinates. Because the window manager +controls icon placement policy, this resource may be ignored. + + + + +XmNiconY + +Specifies a suitable place to put the application's icon; this is a hint +to the window manager in root window coordinates. +Because the window manager +controls icon placement policy, this resource may be ignored. + + + + +XmNinitialState + +Specifies the state the application wants the widget instance to +start in. +It must be one of the constants NormalState or IconicState. + + + + +XmNinput + +Specifies the application's input model for this widget and its +descendants. +The meaning of a True or False value for this resource depends on the +presence or absence of a WM_TAKE_FOCUS atom in the +WM_PROTOCOLS property: + + + + + + + + +Input Model +XmNinput +WM_TAKE_FOCUS + + +No input +False +Absent + + +Passive +True +Absent + + +Locally active +True +Present + + +Globally active +False +Present + + + + +For more information on input models, see the X Consortium Standard +Inter-Client Communication Conventions Manual (ICCCM). + + + + +XmNmaxAspectX + +Specifies the numerator of the maximum aspect ratio (X/Y) that the +application wants the widget instance to have. + + + + +XmNmaxAspectY + +Specifies the denominator of the maximum aspect ratio (X/Y) that the +application wants the widget instance to have. + + + + +XmNmaxHeight + +Specifies the maximum height that the application wants the widget +instance to have. + + + + +XmNmaxWidth + +Specifies the maximum width that the application wants the widget +instance to have. + + + + +XmNminAspectX + +Specifies the numerator of the minimum aspect ratio (X/Y) that the +application wants the widget instance to have. + + + + +XmNminAspectY + +Specifies the denominator of the minimum aspect ratio (X/Y) that the +application wants the widget instance to have. + + + + +XmNminHeight + +Specifies the minimum height that the application wants the widget +instance to have. + + + + +XmNminWidth + +Specifies the minimum width that the application wants the widget +instance to have. + + + + +XmNtitle + +Specifies the application name to be displayed by the window manager. +The default is the icon name, if specified; otherwise, it is the name of the +application. +When XtGetValues is called on this resource, the returned value +is a pointer to the actual resource value and +should not be freed. + + + + +XmNtitleEncoding + +Specifies a property type that represents the encoding of the +XmNtitle string. +If a language procedure has been set, the default is None; otherwise, +the default is XA_STRING. When the widget is realized, if the value +is None, the corresponding name is assumed to be in the current locale. +The name is passed to XmbTextListToTextProperty with an encoding +style of XStdICCTextStyle. The resulting encoding is STRING +if the name is fully convertible to STRING; otherwise it is +COMPOUND_TEXT. +The values of the encoding resources are not changed; they remain None. + + + + +XmNtransient + +Specifies a Boolean value that is True if the widget instance is +transient, typically a popup on behalf of another widget. +The window manager may treat a transient widget's window differently +from other windows. +For example, a window manager may +not iconify a transient window +separately from its associated application. +Applications and users should not normally alter this resource. + + + + +XmNwaitForWm + +When True, specifies that the Intrinsics waits the length of time given +by the XmNwmTimeout resource for the window manager to respond to +certain actions before assuming that there is no window manager present. +This resource is altered by the Intrinsics as it receives, or fails +to receive, responses from the window manager. + + + + +XmNwidthInc + +Specifies the base for a progression of preferred widths for the +window manager to use in sizing the widget. +The preferred widths are XmNbaseWidth plus integral multiples of +XmNwidthInc, with a minimum of XmNminWidth and a maximum of +XmNmaxWidth. +If an initial value is not supplied for XmNwidthInc but is +supplied for XmNheightInc, the value of XmNwidthInc +is set to 1 when the widget is realized. + + + + +XmNwindowGroup + +Specifies the ID of a window with which this widget instance is +associated. +By convention, this window is the "leader" of a group of windows. +A window manager may treat all windows in a group in some way; for +example, it may always move or iconify them together. + +If no initial value is specified, the value is set to the window of the +first realized ancestor widget in the parent hierarchy when the widget +is realized. +If a value of XtUnspecifiedWindowGroup is specified, no window +group is set. + + + + +XmNwinGravity + +Specifies the window gravity for use by the window manager in +positioning the widget. +If no initial value is specified, the value is set when the widget is +realized. +If XmNgeometry is not NULL, XmNwinGravity is set to the +window gravity returned by XWMGeometry. +Otherwise, XmNwinGravity is set to NorthWestGravity. + + + + +XmNwmTimeout + +Specifies the length of time that the Intrinsics waits for the window +manager to respond to certain actions before assuming that there is no +window manager present. +The value is in milliseconds and must not be negative. + + + + + + +Inherited Resources +WMShell inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +False +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for WMShell. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, and &cdeman.Shell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/CloseHie.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/CloseHie.sgm new file mode 100644 index 00000000..76e5a130 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/CloseHie.sgm @@ -0,0 +1,126 @@ + + + + + + + + + + + +MrmCloseHierarchy +library call + + +MrmCloseHierarchy +Closes a UID hierarchy + +MrmCloseHierarchy + +uil functions +MrmCloseHierarchy + +uid hierarchy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> +Cardinal MrmCloseHierarchy + +MrmHierarchy hierarchy_id + +MRM function +MrmCloseHierarchy + +MrmCloseHierarchy +definition + + + +DESCRIPTION +The +MrmCloseHierarchy +function +MrmCloseHierarchy +description + +closes a UID hierarchy previously opened by MrmOpenHierarchyPerDisplay. +All files associated with the hierarchy are closed by the +Motif Resource Manager (MRM) and all associated memory is returned. + + + +hierarchy_id + +Specifies the ID of a previously opened UID hierarchy. +The hierarchy_id was returned in a previous call to +MrmOpenHierarchyPerDisplay. + + + + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmOpenHierarchyPerDisplay;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchBit.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchBit.sgm new file mode 100644 index 00000000..680ef6e1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchBit.sgm @@ -0,0 +1,203 @@ + + + + + + + + + + + +MrmFetchBitmapLiteral +library call + + +MrmFetchBitmapLiteral +Fetches a bitmap literal from a hierarchy + +MrmFetchBitmapLiteral + +uil functions +MrmFetchBitmapLiteral + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchBitmapLiteral + +MrmHierarchy hierarchy_id +String index +Screen *screen +Display *display +Pixmap *pixmap_return +Dimension *width +Dimension *height + +MRM function +MrmFetchBitmapLiteral + +MrmFetchBitmapLiteral +definition + + + +DESCRIPTION + +MrmFetchBitmapLiteral +description + +The MrmFetchBitmapLiteral function fetches a bitmap literal +from an MRM hierarchy, and converts the bitmap literal to an X pixmap +of depth 1. The function returns this pixmap and its width and height. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +specified icon literal. The value of hierarchy_id was returned in +a previous call to MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the bitmap literal to fetch. + + + + +screen + +Specifies the screen used for the pixmap. +The screen argument specifies a pointer to the +Xlib structure Screen which contains the information about that +screen and is linked to the Display structure. +For more information on the Display and Screen structures, +see the Xlib function XOpenDisplay and the associated screen +information macros. + + + + +display + +Specifies the display used for the pixmap. +The display argument specifies the connection to the X server. +For more information on the Display structure, see the Xlib function +XOpenDisplay. + + + + +pixmap_return + +Returns the resulting X pixmap value. +The function allocates space for this pixmap. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmDestroyPixmap. + + + + +width + +Specifies a pointer to the width of the pixmap. + + + + +height + +Specifies a pointer to the height of the pixmap. + + + + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The bitmap literal was not found in the hierarchy. + + + + +MrmWRONG_TYPE + +The caller tried to fetch a literal of a type not supported by this +function. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmFetchIconLiteral;, +&cdeman.MrmFetchLiteral;, and +XOpenDisplay(3). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchCol.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchCol.sgm new file mode 100644 index 00000000..d11be717 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchCol.sgm @@ -0,0 +1,188 @@ + + + + + + + + + + + +MrmFetchColorLiteral +library call + + +MrmFetchColorLiteral +Fetches a named color literal from a UID file + +MrmFetchColorLiteral + +uil functions +MrmFetchColorLiteral + +uid file + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchColorLiteral + +MrmHierarchy hierarchy_id +String index +Display *display +Colormap colormap_id +Pixel *pixel + +MRM function +MrmFetchColorLiteral + +MrmFetchColorLiteral +definition + + + +DESCRIPTION +The +MrmFetchColorLiteral +function +MrmFetchColorLiteral +description + +fetches a named color literal from a UID file, and converts the +color literal to a pixel color value. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +specified literal. +The value of hierarchy_id was returned in a previous call to +MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the color literal to fetch. +You must define this name in UIL as an exported value. + + + + +display + +Specifies the display used for the pixmap. +The +display +argument specifies the connection to the X server. +For more information on the +Display structure, see the Xlib function +XOpenDisplay. + + + + +colormap_id + +Specifies the ID of the color map. +If colormap_id is NULL, the default color map is used. + + + + +pixel + +Returns the ID of the color literal. + + + + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The color literal was not found in the UIL file. + + + + +MrmWRONG_TYPE + +The caller tried to fetch a literal of a type not supported by this +function. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmFetchBitmapLiteral;, +&cdeman.MrmOpenHierarchyPerDisplay;, +&cdeman.MrmFetchIconLiteral;, +&cdeman.MrmFetchLiteral;, and +XOpenDisplay(3). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchIco.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchIco.sgm new file mode 100644 index 00000000..cc9cf999 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchIco.sgm @@ -0,0 +1,218 @@ + + + + + + + + + + + +MrmFetchIconLiteral +library call + + +MrmFetchIconLiteral +Fetches an icon literal from a hierarchy + +MrmFetchIconLiteral + +uil functions +MrmFetchIconLiteral + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchIconLiteral + +MrmHierarchy hierarchy_id +String index +Screen *screen +Display *display +Pixel fgpix +Pixel bgpix +Pixmap *pixmap + +MRM function +MrmFetchIconLiteral + +MrmFetchIconLiteral +definition + + + +DESCRIPTION +The +MrmFetchIconLiteral +function +MrmFetchIconLiteral +description + +fetches an icon literal from an MRM hierarchy and converts the +icon literal to an X pixmap. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +specified icon literal. +The hierarchy_id was returned in a previous call to +MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the icon literal to fetch. + + + + +screen + +Specifies the screen used for the pixmap. +The +screen +argument specifies a pointer to the +Xlib structure +Screen, +which contains the information about that screen and is linked to the +Display +structure. +For more information on the +Display +and +Screen +structures, see the Xlib function +XOpenDisplay +and the associated screen information macros. + + + + +display + +Specifies the display used for the pixmap. +The +display +argument specifies the connection to the X server. +For more information on the +Display structure, see the Xlib function +XOpenDisplay. + + + + +fgpix + +Specifies the foreground color for the pixmap. + + + + +bgpix + +Specifies the background color for the pixmap. + + + + +pixmap + +Returns the resulting X pixmap value. +The function allocates space for this pixmap. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmDestroyPixmap. + + + + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The icon literal was not found in the hierarchy. + + + + +MrmWRONG_TYPE + +The caller tried to fetch a literal of a type not supported by this +function. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmFetchBitmapLiteral;, +&cdeman.MrmOpenHierarchyPerDisplay;, +&cdeman.MrmFetchLiteral;, +&cdeman.MrmFetchColorLiteral;, and +XOpenDisplay(3). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchLit.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchLit.sgm new file mode 100644 index 00000000..5102cf23 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchLit.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + + +MrmFetchLiteral +library call + + +MrmFetchLiteral +Fetches a literal from a UID file + +MrmFetchLiteral + +uil functions +MrmFetchLiteral + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchLiteral + +MrmHierarchy hierarchy_id +String index +Display *display +XtPointer *value +MrmCode *type + +MRM function +MrmFetchLiteral + +MrmFetchLiteral +definition + + + +DESCRIPTION +The +MrmFetchLiteral +function +MrmFetchLiteral +description + +reads and returns the value and type of a literal (named value) +that is stored as +a public resource in a single UID file. +This function returns a pointer to the value of the literal. +For example, an integer is always returned as a pointer to an integer, +and a string is always returned as a pointer to a string. + +Applications should not use +MrmFetchLiteral +for fetching icon or color literals. +If this is attempted, +MrmFetchLiteral +returns an error. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +specified literal. +The value of hierarchy_id was returned in a previous call to +MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the literal (pixmap) to fetch. +You must define this name in UIL as an exported value. + + + + +display + +Specifies the display used for the pixmap. +The +display +argument specifies the connection to the X server. +For more information on the +Display structure, see the Xlib function +XOpenDisplay. + + + + +value + +Returns the ID of the named literal's value. +The function allocates space for the returned value. +The application is responsible for managing the allocated space +by calling the appropriate deallocation function. For example, +if the returned ID symbolizes a pixmap, then the application can +recover the allocated space by calling XmDestroyPixmap. + + + + +type + +Returns the named literal's data type. +Types are defined in the include file Mrm/MrmPublic.h. + + + + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The literal was not found in the UIL file. + + + + +MrmWRONG_TYPE + +The caller tried to fetch a literal of a type not supported by this +function. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmFetchBitmapLiteral;, +&cdeman.MrmOpenHierarchyPerDisplay;, +&cdeman.MrmFetchIconLiteral;, +&cdeman.MrmFetchColorLiteral;, and +XOpenDisplay(3). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchSet.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchSet.sgm new file mode 100644 index 00000000..6db0e4d2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchSet.sgm @@ -0,0 +1,214 @@ + + + + + + + + + + + +MrmFetchSetValues +library call + + +MrmFetchSetValues +Fetches the values to be set from literals stored in +UID files + +MrmFetchSetValues + +uil functions +MrmFetchSetValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchSetValues + +MrmHierarchy hierarchy_id +Widget widget +ArgList args +Cardinal num_args + +MRM function +MrmFetchSetValues + +MrmFetchSetValues +definition + + + +DESCRIPTION +The +MrmFetchSetValues +function +is similar to +XtSetValues, +except that the values to be set are defined by the UIL named +values that are stored in the UID hierarchy. +MrmFetchSetValues +description + +MrmFetchSetValues +fetches the values to be set from literals stored in UID files. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +specified literal. +The value of hierarchy_id +was returned in a previous call to MrmOpenHierarchyPerDisplay. + + + + +widget + +Specifies the widget that is modified. + + + + +args + +Specifies an argument list that identifies the widget arguments to be +modified as well as the index (UIL name) of the literal that +defines the value for that argument. +The name part of each argument (args[n].name) must begin with the string +XmN followed by the name that uniquely identifies this attribute tag. +For example, XmNwidth +is the attribute name associated with the core argument width. +The value part (args[n].value) must be a string +that gives the index (UIL name) of the literal. +You must define all literals in UIL as exported values. + + + + +num_args + +Specifies the number of entries in args. + + + + +This function +sets the values +on a widget, evaluating the +values as public literal resource references resolvable from +a UID hierarchy. +Each literal is fetched from the hierarchy, and +its value is modified and converted as required. +This value is +then placed in the argument list and used as the actual value for an +XtSetValues +call. +MrmFetchSetValues +allows a widget to be modified +after creation using UID file values the same way +creation values are used in MrmFetchWidget. + +As in +MrmFetchWidget, +each argument whose value can be evaluated +from +the UID hierarchy is set in the widget. +Values that are not +found +or values in which conversion errors occur are not modified. + +Each entry in the argument list identifies an argument to be modified +in the widget. +The name part identifies the tag, which begins with +XmN. +The value part must be a string +whose value is the index of +the literal. +Thus, the following code would modify the label resource of the widget +to have the value of the literal accessed by the index +OK_button_label in the hierarchy: + + +args[n].name = XmNlabel; +args[n].value = "OK_button_label"; + + + + +RETURN VALUE + +MrmSUCCESS + +MrmPARTIAL_SUCCESS + +MrmBAD_HIERARCHY + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmPARTIAL_SUCCESS + +At least one literal was successfully fetched. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmOpenHierarchyPerDisplay;, +XtSetValues(3). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiA.sgm new file mode 100644 index 00000000..65cd1e6c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiA.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + + +MrmFetchWidget +library call + + +MrmFetchWidget +Fetches and creates an indexed (UIL named) application widget and its children + +MrmFetchWidget + +uil functions +MrmFetchWidget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchWidget + +MrmHierarchy hierarchy_id +String index +Widget parent_widget +Widget *widget +MrmType *class + +MRM function +MrmFetchWidget + +MrmFetchWidget +definition + + + +DESCRIPTION +The +MrmFetchWidget +function +MrmFetchWidget +description + +fetches and creates an +indexed application widget and its children. +The indexed application widget is any widget that is named in UIL. +In +fetch operations, the fetched widget's subtree is also +fetched and created. +This widget must not appear as the child of a widget within its own +subtree. MrmFetchWidget does not execute XtManageChild +for the newly created widget. + +All widgets fetched by a call to MrmFetchWidget are not managed +at the time of their creation callbacks. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains the +interface definition. +The value of hierarchy_id was returned in a previous call to +MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the widget to fetch. + + + + +parent_widget + +Specifies the parent widget ID. + + + + +widget + +Returns the widget ID of the created widget. + + + + +class + +This argument must be set to an actual pointer; it +cannot be a NULL pointer. MrmFetchWidget sets this argument to +an implementation dependent value. + + + + +An application can fetch +any named widget in the UID hierarchy using +MrmFetchWidget. +MrmFetchWidget +can be called at any time to fetch a widget that was not fetched at +application startup. +MrmFetchWidget +can be used to defer fetching pop-up +widgets until they are first +referenced (presumably in a callback), and then used to fetch them +once. + +MrmFetchWidget +can also create multiple instances of a widget (and its subtree). +In this case, the UID definition functions as a template; +a widget definition can be fetched any number of times. +An application can use +this template to make multiple instances of a widget, for example, in a +dialog box box or menu. + +The index (UIL name) that identifies the widget must be +known to the application. + + + +RETURN + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The widget was not found in UID hierarchy. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmOpenHierarchyPerDisplay;, +&cdeman.MrmFetchWidgetOverride;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiB.sgm new file mode 100644 index 00000000..e9a59247 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/FetchWiB.sgm @@ -0,0 +1,211 @@ + + + + + + + + + + + +MrmFetchWidgetOverride +library call + + +MrmFetchWidgetOverride +Fetches any indexed (UIL named) application widget. It overrides the arguments specified for this application widget in UIL + +MrmFetchWidgetOverride + +uil functions +MrmFetchWidgetOverride + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmFetchWidgetOverride + +MrmHierarchy hierarchy_id +String index +Widget parent_widget +String override_name +ArgList override_args +Cardinal override_num_args +Widget *widget +MrmType *class + +MRM function +MrmFetchWidgetOverride + +MrmFetchWidgetOverride +definition + + + +DESCRIPTION +The MrmFetchWidgetOverride function +MrmFetchWidgetOverride +description + +is the extended version of MrmFetchWidget. +It is identical to MrmFetchWidget, except that it +allows the caller to override the widget's name and any +arguments that MrmFetchWidget +would otherwise retrieve from the UID file or +one of the defaulting mechanisms. +That is, the override argument list is not +limited to those arguments in the UID file. + +The override arguments apply only to the widget fetched and +returned +by this function. +Its children (subtree) do not receive any +override +parameters. + + + +hierarchy_id + +Specifies the ID of the UID hierarchy that contains +the interface definition. +The value of hierarchy_id +was returned in a previous call to MrmOpenHierarchyPerDisplay. + + + + +index + +Specifies the UIL name of the widget to fetch. + + + + +parent_widget + +Specifies the parent widget ID. + + + + +override_name + +Specifies the name to override the widget name. +Use a NULL value if you do not want to override the widget name. + + + + +override_args + +Specifies the override argument list, exactly as given to +XtCreateWidget +(conversion complete and so forth). +Use a +NULL value if you do not want to override the argument list. + + + + +override_num_args + +Specifies the number of arguments in +override_args. + + + + +widget + +Returns the widget ID of the created widget. + + + + +class + +Returns the class code identifying MRM's widget class. +Literals identifying MRM widget class codes are defined in +the include file Mrm/MrmPublic.h. + + + + + + +RETURN VALUE + +MrmSUCCESS + +MrmBAD_HIERARCHY + +MrmNOT_FOUND + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmBAD_HIERARCHY + +The hierarchy ID was invalid. + + + + +MrmNOT_FOUND + +The widget was not found in UID hierarchy. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmOpenHierarchyPerDisplay;, +&cdeman.MrmFetchWidget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/Initiali.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/Initiali.sgm new file mode 100644 index 00000000..d7e30904 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/Initiali.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +MrmInitialize +library call + + +MrmInitialize +Prepares an application to use MRM widget-fetching facilities + +MrmInitialize + +uil functions +MrmInitialize + + + + + + + + + + + + + + + + + + + + + + + + + +void MrmInitialize + + +MRM function +MrmInitialize + +MrmInitialize +definition + + + +DESCRIPTION +The +MrmInitialize +function must be called to prepare an application to use MRM +widget-fetching facilities. +You must call this function prior to fetching a widget. +However, it is good programming practice to call +MrmInitialize +prior to performing any +MRM operations. + +MrmInitialize +initializes +MrmInitialize +description + +the internal data structures that MRM needs to +successfully perform type +conversion on arguments and to successfully access widget creation +facilities. +An application must call +MrmInitialize +before it uses other +MRM functions. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieA.sgm new file mode 100644 index 00000000..7038fb89 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieA.sgm @@ -0,0 +1,391 @@ + + + + + + + + + + + +MrmOpenHierarchy +library call + + +MrmOpenHierarchy +Allocates a hierarchy ID and opens all the UID files in +the hierarchy + +MrmOpenHierarchy + +uil functions +MrmOpenHierarchy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmOpenHierarchy + +MrmCount num_files +String file_names_list[] +MrmOsOpenParamPtr *ancillary_structures_list +MrmHierarchy *hierarchy_id + +MRM function +MrmOpenHierarchy + +MrmOpenHierarchy +definition + + + +DESCRIPTION +This routine is obsolete and exists for compatibility with previous +releases. It is replaced by MrmOpenHierarchyPerDisplay. +MrmOpenHierarchy is identical to MrmOpenHierarchyPerDisplay +except that MrmOpenHierarchy does not take a display +argument. + + + +num_files + +Specifies the number of files in the name list. + + + + +file_names_list + +Specifies an array of character strings that identify +the UID files. + + + + +ancillary_structures_list + +A list of operating-system-dependent ancillary structures corresponding +to items such as filenames, clobber flags, and so forth. +This argument should be NULL for most operations. +If you need to reference this structure, +see the definition of +MrmOsOpenParamPtr +in the MrmPublic.h header file for more information. + + + + +hierarchy_id + +Returns the search hierarchy ID. +The search hierarchy ID identifies the list of UID files that +MRM searches (in order) when performing subsequent +fetch calls. + + + + +Each UID file string in file_names_list can specify either a full +pathname or a filename. +If a UID file string has a leading slash (/), it specifies a full +pathname, and MRM opens the file as specified. +Otherwise, the UID file string specifies a filename. +In this case, MRM looks for the file along a search path specified by the +UIDPATH environment variable or by a default search path, which +varies depending on whether or not the XAPPLRESDIR environment +variable is set. + +The UIDPATH environment variable specifies a search path and +naming conventions associated with UID files. +It can contain the substitution field %U, where the UID file string from +the file_names_list argument to MrmOpenHierarchyPerDisplay is +substituted for %U. +It can also contain the substitution fields accepted by +XtResolvePathname. +The substitution field %T is always mapped to uid. +The entire path is first searched with %S mapped to &npzwc;.uid. +If no file is found, it is searched again with %S mapped to NULL. + +If no display is set prior to calling this function, the result of +this function's call to XtResolvePathname is undefined. + +For example, the following UIDPATH value and +MrmOpenHierarchy call cause MRM to open two separate UID files: + + +UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L + static char *uid_files[] = {"/usr/users/me/test.uid", "test2"}; + MrmHierarchy *Hierarchy_id; + MrmOpenHierarchy((MrmCount)2,uid_files, NULL, Hierarchy_id) + + +MRM opens the first file, /usr/users/me/test.uid, as specified in +the file_names_list argument to MrmOpenHierarchy, because +the UID file string in the file_names_list argument specifies a +full pathname. +MRM looks for the second file, +test2, +first as +/uidlib/%L/test2.uid +and second as +/uidlib/test2/%L, +where the display's language string is substituted for %L. + +After +MrmOpenHierarchy +opens the UID hierarchy, you should not delete or modify the +UID files until you close the UID hierarchy by calling +MrmCloseHierarchy. + +If UIDPATH is not set but the environment variable +XAPPLRESDIR is set, MRM searches the following pathnames: + + + +%U%S + + + +$XAPPLRESDIR/%L/uid/%N/%U%S + + + +$XAPPLRESDIR/%l/uid/%N/%U%S + + + +$XAPPLRESDIR/uid/%N/%U%S + + + +$XAPPLRESDIR/%L/uid/%U%S + + + +$XAPPLRESDIR/%l/uid/%U%S + + + +$XAPPLRESDIR/uid/%U%S + + + +$HOME/uid/%U%S + + + +$HOME/%U%S + + + +/usr/lib/X11/%L/uid/%N/%U%S + + + +/usr/lib/X11/%l/uid/%N/%U%S + + + +/usr/lib/X11/uid/%N/%U%S + + + +/usr/lib/X11/%L/uid/%U%S + + + +/usr/lib/X11/%l/uid/%U%S + + + +/usr/lib/X11/uid/%U%S + + + +/usr/include/X11/uid/%U%S + + + +If neither UIDPATH nor XAPPLRESDIR is set, MRM searches the +following pathnames: + + + +%U%S + + + +HOME/%L/uid/%N/%U%S + + + +HOME/%l/uid/%N/%U%S + + + +$HOME/uid/%N/%U%S + + + +$HOME/%L/uid/%U%S + + + +$HOME/%l/uid/%U%S + + + +$HOME/uid/%U%S + + + +$HOME/%U%S + + + +/usr/lib/X11/%L/uid/%N/%U%S + + + +/usr/lib/X11/%l/uid/%N/%U%S + + + +/usr/lib/X11/uid/%N/%U%S + + + +/usr/lib/X11/%L/uid/%U%S + + + +/usr/lib/X11/%l/uid/%U%S + + + +/usr/lib/X11/uid/%U%S + + + +/usr/include/X11/uid/%U%S + + + +These paths are defaults that vendors may change. +For example, a vendor may use different directories for +/usr/lib/X11 and /usr/include/X11. + +The following substitutions are used in these paths: + + + +%U + +The UID file string, from the file_names_list argument. + + + + +%N + +The class name of the application. + + + + +%L + +The display's language string. +This string is influenced by XtSetLanguageProc. +The default string is determined by +calling setlocale(LC_ALL, NULL). + + + + +%l + +The language component of the display's language string. + + + + +%S + +The suffix to the filename. +The entire path is first searched with a suffix of +.uid. +If +no file is found, it is searched again with a NULL suffix. + + + + + + +RETURN +This function returns one of the following status return constants: +MrmSUCCESS + +MrmNOT_FOUND + +MrmFAILURE + + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmNOT_FOUND + +File not found. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmOpenHierarchyPerDisplay; and +&cdeman.MrmCloseHierarchy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieB.sgm new file mode 100644 index 00000000..e1031ea7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieB.sgm @@ -0,0 +1,103 @@ + + + + + + + + + + + +MrmOpenHierarchyFromBuffer +library call + + +MrmOpenHierarchyFromBuffer +Allocates a hierarchy ID and opens a buffer containing a memory image of a UID file + +MrmOpenHierarchyFrom\\%Buffer + +uil functions +MrmOpenHierarchyFrom\\%Buffer + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmOpenHierarchyFromBuffer + +unsigned char uid_buffer +MrmHierarchy *hierarchy_id + + + +DESCRIPTION +MrmOpenHierarchyFromBuffer allows you to specify a buffer +containing information from UID files that MRM searches in subsequent +fetch operations. +This function also allocates a hierarchy ID and initializes the +optimized search lists in the hierarchy. + + + +buffer + +Specifies a stream of bytes containing information from UID files + + + + +hierarchy_id + +Returns the search hierarchy ID. +The search hierarchy ID identifies the buffer that MRM searches when +performing subsequent fetch calls. + + + + + + +RETURN +This function returns one of the following status return constants: +MrmSUCCESS + +MrmFAILURE + + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmCloseHierarchy; and +&cdeman.MrmOpenHierarchyPerDisplay;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieC.sgm new file mode 100644 index 00000000..7f8499a6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/OpenHieC.sgm @@ -0,0 +1,401 @@ + + + + + + + + + + + +MrmOpenHierarchyPerDisplay +library call + + +MrmOpenHierarchyPerDisplay +Allocates a hierarchy ID and opens all the UID files in the hierarchy + +MrmOpenHierarchyPer\\%Display + +uil functions +MrmOpenHierarchyPer\\%Display + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmOpenHierarchyPerDisplay + +Display *display +MrmCount num_files +String file_names_list[] +MrmOsOpenParamPtr *ancillary_structures_list +MrmHierarchy *hierarchy_id + + + +DESCRIPTION +MrmOpenHierarchyPerDisplay allows you to specify the list +of UID files that MRM searches in subsequent fetch operations. +All subsequent fetch operations return the first occurrence of the +named item encountered while traversing the UID hierarchy from +the first list element (UID file specification) to the last list +element. +This function also +allocates a hierarchy ID and opens all the UID files in the +hierarchy. +It initializes the optimized search lists in the hierarchy. +If +MrmOpenHierarchyPerDisplay +encounters any errors during its execution, any files that were opened +are closed. + +The application must call XtAppInitialize before calling +MrmOpenHierarchyPerDisplay. + + + +display + +Specifies the connection to the X server and the value to pass +to XtResolvePathname. For more information on the Display +structure, see the Xlib function XOpenDisplay. + + + + +num_files + +Specifies the number of files in the name list. + + + + +file_names_list + +Specifies an array of character strings that identify +the UID files. + + + + +ancillary_structures_list + +A list of operating-system-dependent ancillary structures corresponding +to items such as filenames, clobber flags, and so forth. +This argument should be NULL for most operations. +If you need to reference this structure, +see the definition of +MrmOsOpenParamPtr +in the MrmPublic.h header file for more information. + + + + +hierarchy_id + +Returns the search hierarchy ID. +The search hierarchy ID identifies the list of UID files that +MRM searches (in order) when performing subsequent +fetch calls. + + + + +Each UID file string in file_names_list can specify either a full +pathname or a filename. +If a UID file string has a leading / (slash), it specifies a full +pathname, and MRM opens the file as specified. +Otherwise, the UID file string specifies a filename. +In this case MRM looks for the file along a search path specified by the +UIDPATH environment variable or by a default search path, which +varies depending on whether or not the XAPPLRESDIR environment +variable is set. + +The UIDPATH environment variable specifies a search path and +naming conventions associated with UID files. +It can contain the substitution field %U, where the UID file string from +the file_names_list argument to MrmOpenHierarchyPerDisplay is +substituted for %U. +It can also contain the substitution fields accepted by +XtResolvePathname. +The substitution field %T is always mapped to uid. +The entire path is searched first with %S mapped to .uid. +If no file is found, it is searched again with %S mapped to NULL. +For example, the following UIDPATH value and +MrmOpenHierarchyPerDisplay call cause MRM to open two separate UID +files: + + +UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L + static char *uid_files[] = {"/usr/users/me/test.uid", "test2"}; + MrmHierarchy *Hierarchy_id; + MrmOpenHierarchyPerDisplay((MrmCount)2,uid_files, NULL, Hierarchy_id) + + +MRM opens the first file, /usr/users/me/test.uid, as specified in +the file_names_list argument to MrmOpenHierarchyPerDisplay, +because the UID file string in the file_names_list argument +specifies a full pathname. +MRM looks for the second file, +test2, +first as +/uidlib/%L/test2.uid +and second as +/uidlib/test2/%L, +where the display's language string is substituted for %L. + +After +MrmOpenHierarchyPerDisplay +opens the UID hierarchy, you should not delete or modify the +UID files until you close the UID hierarchy by calling +MrmCloseHierarchy. + +If UIDPATH is not set, but the environment variable +XAPPLRESDIR is set, MRM searches the following pathnames: + + + +%U%S + + + +$XAPPLRESDIR/%L/uid/%N/%U%S + + + +$XAPPLRESDIR/%l/uid/%N/%U%S + + + +$XAPPLRESDIR/uid/%N/%U%S + + + +$XAPPLRESDIR/%L/uid/%U%S + + + +$XAPPLRESDIR/%l/uid/%U%S + + + +$XAPPLRESDIR/uid/%U%S + + + +$HOME/uid/%U%S + + + +$HOME/%U%S + + + +/usr/lib/X11/%L/uid/%N/%U%S + + + +/usr/lib/X11/%l/uid/%N/%U%S + + + +/usr/lib/X11/uid/%N/%U%S + + + +/usr/lib/X11/%L/uid/%U%S + + + +/usr/lib/X11/%l/uid/%U%S + + + +/usr/lib/X11/uid/%U%S + + + +/usr/include/X11/uid/%U%S + + + +If neither UIDPATH nor XAPPLRESDIR is set, MRM searches the +following pathnames: + + + +%U%S + + + +$HOME/%L/uid/%N/%U%S + + + +$HOME/%l/uid/%N/%U%S + + + +$HOME/uid/%N/%U%S + + + +$HOME/%L/uid/%U%S + + + +$HOME/%l/uid/%U%S + + + +$HOME/uid/%U%S + + + +$HOME/%U%S + + + +/usr/lib/X11/%L/uid/%N/%U%S + + + +/usr/lib/X11/%l/uid/%N/%U%S + + + +/usr/lib/X11/uid/%N/%U%S + + + +/usr/lib/X11/%L/uid/%U%S + + + +/usr/lib/X11/%l/uid/%U%S + + + +/usr/lib/X11/uid/%U%S + + + +/usr/include/X11/uid/%U%S + + + +These paths are defaults that vendors may change. +For example, a vendor may use different directories for +/usr/lib/X11 and /usr/include/X11. + +The following substitutions are used in these paths: + + + +%U + +The UID file string, from the file_names_list argument. + + + + +%N + +The class name of the application. + + + + +%L + +The display's language string. +This string is influenced by XtSetLanguageProc. +The default string is determined by +calling setlocale(LC_ALL, NULL). + + + + +%l + +The language component of the display's language string. + + + + +%S + +The suffix to the filename. +The entire path is first searched with a suffix of +.uid. +If +no file is found, it is searched again with a NULL suffix. + + + + + + +RETURN +This function returns one of the following status return constants: +MrmSUCCESS + +MrmNOT_FOUND + +MrmFAILURE + + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmNOT_FOUND + +File not found. + + + + +MrmFAILURE + +The function failed. + + + + + + +RELATED +&cdeman.MrmCloseHierarchy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteA.sgm new file mode 100644 index 00000000..c6830cd3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteA.sgm @@ -0,0 +1,166 @@ + + + + + + + + + + + +MrmRegisterClass +library call + + +MrmRegisterClass +Saves the information needed for MRM to access the widget creation function for user-defined widgets + +MrmRegisterClass + +uil functions +MrmRegisterClass + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmRegisterClass + +MrmType class_code +String class_name +String create_name +Widget (*create_proc) () +WidgetClass class_record + +MRM function +MrmRegisterClass + +MrmRegisterClass +definition + + + +DESCRIPTION +The +MrmRegisterClass +function +MrmRegisterClass +description + +allows MRM to access user-defined widget classes. +This function registers the necessary information for +MRM to create widgets of this class. +You must call +MrmRegisterClass +prior to fetching any user-defined class widget. + +MrmRegisterClass +saves the information needed to access the widget creation +function and to do type conversion of argument lists by using the +information in MRM databases. + + + +class_code + +This argument is ignored; it is present for compatibility with previous +releases. + + + + +class_name + +This argument is ignored; it is present for compatibility with previous +releases. + + + + +create_name + +Specifies the case-sensitive name of the low-level widget creation +function for the class. +An example from the Motif Toolkit is +XmCreateLabel. +Arguments are +parent_widget, +name, +override_arglist, +and +override_argcount. + +For user-defined widgets, +create_name +is the creation procedure in the UIL that defines this widget. + + + + +create_proc + +Specifies the address of the creation function that you named in +create_name. + + + + +class_record + +Specifies a pointer to the class record. + + + + + + +RETURN + +MrmSUCCESS + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmFAILURE + +The function failed. + + + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteB.sgm new file mode 100644 index 00000000..c79677f1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteB.sgm @@ -0,0 +1,191 @@ + + + + + + + + + + + +MrmRegisterNames +library call + + +MrmRegisterNames +Registers the values associated with the names referenced in UIL (for example, UIL callback function names or UIL identifier names) + +MrmRegisterNames + +uil functions +MrmRegisterNames + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmRegisterNames + +MrmRegisterArglist register_list +MrmCount register_count + +MRM function +MrmRegisterNames + +MrmRegisterNames +definition + + + +DESCRIPTION +The +MrmRegisterNames +function +MrmRegisterNames +description + +registers a vector of names and associated values +for access in MRM. +The values can be callback functions, pointers +to user-defined data, or any other values. +The information provided is used to resolve symbolic references +occurring in UID files to their run-time values. +For callbacks, this information provides the procedure address required +by the Motif Toolkit. +For names used as identifiers in UIL, this information +provides any +run-time mapping the application needs. + +This function is similar to +MrmRegisterNamesInHierarchy, +except that the scope of the names registered by +MrmRegisterNamesInHierarchy +is limited to the hierarchy specified in the call to that function, +whereas the names registered by +MrmRegisterNames +have global scope. +When MRM looks up a name, it first tries to find the name among those +registered for the given hierarchy. +If that lookup fails, it tries to find the name among those registered +globally. + + + +register_list + +Specifies a list of name/value pairs for the names to be registered. +Each name is a case-sensitive, NULL-terminated ASCII string. +Each value is a 32-bit quantity, interpreted as a procedure address if +the name is a callback function, and uninterpreted otherwise. + + + + +register_count + +Specifies the number of entries in +register_list. + + + + +The names in the list are case-sensitive. +The list can be either ordered or unordered. + +Callback functions registered through +MrmRegisterNames +can be either +regular or creation callbacks. +Regular callbacks have declarations determined by Motif Toolkit and user +requirements. +Creation callbacks have the same format as any other callback: + + +void CallBackProc + +Widget *widget_id +Opaque tag +XmAnyCallbackStruct *callback_data + + + +widget_id + +Specifies the widget ID associated with the widget performing the +callback (as in any callback function). + + + + +tag + +Specifies the tag value (as in any callback function). + + + + +callback_data + +Specifies a widget-specific data structure. +This data structure has a minimum of two members: event and reason. +The reason member is always set to +MrmCR_CREATE. + + + + +Note that the widget name and parent are available from the widget +record accessible through +widget_id. + + + +RETURN + +MrmSUCCESS + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmFAILURE + +The function failed. + + + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteC.sgm new file mode 100644 index 00000000..4f9c0263 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Mrm/RegisteC.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + + +MrmRegisterNamesInHierarchy +library call + + +MrmRegisterNamesInHierarchy +Registers the values associated with the names referenced in UIL within a single hierarchy (for example, UIL callback function names or UIL identifier names) + +MrmRegisterNamesIn\\%Hierarchy + +uil functions +MrmRegisterNamesIn\\%Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Mrm/MrmPublic.h> + +Cardinal MrmRegisterNamesInHierarchy + +MrmHierarchy hierarchy_id +MrmRegisterArglist register_list +MrmCount register_count + +MRM function +MrmRegisterNamesIn\\%Hierarchy + +MrmRegisterNamesIn\\%Hierarchy +definition + + + +DESCRIPTION +The +MrmRegisterNamesInHierarchy +function +MrmRegisterNamesIn\\%Hierarchy +description + +registers a vector of names and associated values +for access in MRM. +The values can be callback functions, pointers +to user-defined data, or any other values. +The information provided is used to resolve symbolic references +occurring in UID files to their run-time +values. For callbacks, this information +provides the procedure address required +by the Motif Toolkit. +For names used as identifiers in UIL, this information +provides any +run-time mapping the application needs. + +This function is similar to +MrmRegisterNames, +except that the scope of the names registered by +MrmRegisterNamesInHierarchy +is limited to the hierarchy specified by +hierarchy_id, +whereas the names registered by +MrmRegisterNames +have +global scope. +When MRM looks up a name, it first tries to find the name among those +registered for the given hierarchy. +If that lookup fails, it tries to find the name among those registered +globally. + + + +hierarchy_id + +Specifies the hierarchy with which the names are to be associated. + + + + +register_list + +Specifies a list of name/value pairs for the names to be registered. +Each name is a case-sensitive, NULL-terminated ASCII string. +Each value is a 32-bit quantity, interpreted as a procedure address if +the name is a callback function, and uninterpreted otherwise. + + + + +register_count + +Specifies the number of entries in +register_list. + + + + +The names in the list are case-sensitive. +The list can be either ordered or unordered. + +Callback functions registered through +MrmRegisterNamesInHierarchy +can be either +regular or creation callbacks. +Regular callbacks have declarations determined by Motif Toolkit and user +requirements. +Creation callbacks have the same format as any other callback: + + +void CallBackProc + +Widget *widget_id +Opaque tag +XmAnyCallbackStruct *callback_data + + + +widget_id + +Specifies the widget ID associated with the widget performing the +callback (as in any callback function). + + + + +tag + +Specifies the tag value (as in any callback function). + + + + +callback_data + +Specifies a widget-specific data structure. +This data structure has a minimum of two members: event and reason. +The reason member is always set to +MrmCR_CREATE. + + + + +Note that the widget name and parent are available from the widget +record accessible through +widget_id. + + + +RETURN + +MrmSUCCESS + +MrmFAILURE + +This function returns one of the following status return constants: + + + +MrmSUCCESS + +The function executed successfully. + + + + +MrmFAILURE + +The function failed. + + + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivP.sgm new file mode 100644 index 00000000..f0095b06 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivP.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmActivateProtocol +library call + + +XmActivateProtocol +A VendorShell function that activates a protocol + +XmActivateProtocol + +VendorShell functions +XmActivateProtocol + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmActivateProtocol + +Widget shell +Atom property +Atom protocol + + + +DESCRIPTION +XmActivateProtocol activates a protocol. It +updates the handlers and the property if +the shell is realized. It is sometimes useful to allow +a protocol's state information (callback lists, and so on) to persist, even though +the client may choose to temporarily resign from the interaction. This is +supported by allowing a protocol to be in one of two states: active or +inactive. If the protocol is active and the shell is realized, +the property contains the protocol Atom. +If the protocol is inactive, the Atom is not present in +the property. + +XmActivateWMProtocol is a convenience interface. +It calls XmActivateProtocol +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocol + +Specifies the protocol Atom + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, &cdeman.XmActivateWMProtocol;, +&cdeman.XmRemoveProtocols; +and &cdeman.XmInternAtom;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivW.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivW.sgm new file mode 100644 index 00000000..e731bbc2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ActivW.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmActivateWMProtocol +library call + + +XmActivateWMProtocol +A VendorShell convenience interface that activates a protocol + +XmActivateWMProtocol + +VendorShell functions +XmActivateWMProtocol + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmActivateWMProtocol + +Widget shell +Atom protocol + + + +DESCRIPTION +XmActivateWMProtocol is a convenience interface. +It calls XmActivateProtocol +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocol + +Specifies the protocol Atom + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmActivateProtocol;, +&cdeman.XmInternAtom;, and +&cdeman.XmRemoveWMProtocols;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtA.sgm new file mode 100644 index 00000000..4f9d139f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtA.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmAddProtocolCallback +library call + + +XmAddProtocolCallback +A VendorShell function that adds client callbacks for a protocol + +XmAddProtocolCallback + +VendorShell functions +XmAddProtocolCallback + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmAddProtocolCallback + +Widget shell +Atom property +Atom protocol +XtCallbackProc callback +XtPointer closure + + + +DESCRIPTION +XmAddProtocolCallback adds client callbacks for a protocol. It +checks if the protocol is registered, and if it is not, +calls XmAddProtocols. It then adds the callback to +the internal list. These callbacks are called when +the corresponding client message is received. + +XmAddWMProtocolCallback is a convenience interface. +It calls XmAddProtocolCallback +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocol + +Specifies the protocol Atom + + + + +callback + +Specifies the procedure to call when a protocol message is received + + + + +closure + +Specifies the client data to be passed to the callback when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddWMProtocolCallback;, +&cdeman.XmInternAtom;, and +&cdeman.XmRemoveProtocolCallback;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtB.sgm new file mode 100644 index 00000000..a5f736ab --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddProtB.sgm @@ -0,0 +1,112 @@ + + + + + + + + + + + +XmAddProtocols +library call + + +XmAddProtocols +A VendorShell function that adds the protocols to the protocol manager and allocates the internal tables + +XmAddProtocols + +VendorShell functions +XmAddProtocols + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmAddProtocols + +Widget shell +Atom property +Atom *protocols +Cardinal num_protocols + + + +DESCRIPTION +XmAddProtocols adds the protocols to the +protocol manager and allocates the internal tables. + +XmAddWMProtocols is a convenience interface. +It calls XmAddProtocols +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocols + +Specifies the protocol Atoms + + + + +num_protocols + +Specifies the number of elements in protocols + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddWMProtocols;, +&cdeman.XmInternAtom;, and +&cdeman.XmRemoveProtocols;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddTabGr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddTabGr.sgm new file mode 100644 index 00000000..62951813 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddTabGr.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmAddTabGroup +library call + + +XmAddTabGroup +A function that adds a manager or a primitive +widget to the list of tab groups + +XmAddTabGroup + +VendorShell functions +XmAddTabGroup + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmAddTabGroup + +Widget tab_group + + + +DESCRIPTION +This function is obsolete and its behavior is replaced by setting +XmNnavigationType to XmEXCLUSIVE_TAB_GROUP. +When the keyboard is used to traverse through a widget hierarchy, primitive +or manager +widgets are grouped together into what are known as tab groups. Any +manager or primitive widget can be a tab group. Within +a tab group, move the focus to the next widget in the tab +group by using the arrow keys. To move to another tab group, use +KNextField or KPrevField. + +Tab groups are ordinarily specified by the XmNnavigationType +resource. +XmAddTabGroup is called to control the order of traversal of tab +groups. The widget specified +by tab_group is appended to the list of tab +groups to be traversed, and the widget's XmNnavigationType is set +to XmEXCLUSIVE_TAB_GROUP. + + + +tab_group + +Specifies the manager or primitive widget ID + + + + + + +RELATED +&cdeman.XmManager;, +&cdeman.XmGetTabGroup;, +&cdeman.XmPrimitive;, and +&cdeman.XmRemoveTabGroup;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddToPos.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddToPos.sgm new file mode 100644 index 00000000..1fab7523 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddToPos.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmAddToPostFromList +library call + + +XmAddToPostFromList +a RowColumn function that makes a menu +accessible from more than one widget + +XmAddToPostFromList + +RowColumn functions +XmAddToPostFromList + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +void XmAddToPostFromList + +Widget menu +Widget post_from_widget + + + +DESCRIPTION +XmAddToPostFromList makes a menu accessible from more than one +widget. After a menu is once created, this function may be used to +make that menu accessible from a second widget. The process may be +repeated indefinitely. In other words, where an application would use +XmCreatePopupMenu or XmCreatePulldownMenu or their +equivalent to create a new menu identical to one that already exists, +it can use this function to reuse that earlier menu. + +If menu refers to a Popup menu, then the post_from_widget +widget can now pop up the specified menu. The actual posting of the +menu occurs as it always does, either through an event handler, or the +automatic popup menu support (see the &cdeman.XmRowColumn; reference +page). + +If menu refers to a Pulldown menu, its ID is placed in the +XmNsubMenuId resource of the specified post_from_widget. +In this case, the post_from_widget widget must be either a +CascadeButton or a CascadeButtonGadget. + +Note that this function manipulates the internal structures +themselves, not a copy of them. + + + +menu + +Specifies the ID of the RowColumn widget containing the menu (Popup or +Pulldown) to be made accessible from the widget. + + + + +post_from_widget + +Specifies the widget ID of the widget which will now be able to post +the menu specified by menu. + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RELATED +&cdeman.XmGetPostedFromWidget;, +&cdeman.XmRemoveFromPostFromList;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrA.sgm new file mode 100644 index 00000000..bf889d4a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrA.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmAddWMProtocolCallback +library call + + +XmAddWMProtocolCallback +A VendorShell convenience interface that adds client callbacks for a protocol + +XmAddWMProtocol\\%Callback + +VendorShell functions +XmAddWMProtocol\\%Callback + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmAddWMProtocolCallback + +Widget shell +Atom protocol +XtCallbackProc callback +XtPointer closure + + + +DESCRIPTION +XmAddWMProtocolCallback is a convenience interface. +It calls XmAddProtocolCallback +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocol + +Specifies the protocol Atom + + + + +callback + +Specifies the procedure to call when a protocol message is received + + + + +closure + +Specifies the client data to be passed to the callback when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddProtocolCallback;, +&cdeman.XmInternAtom;, and +&cdeman.XmRemoveWMProtocolCallback;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrB.sgm new file mode 100644 index 00000000..cb7e5840 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/AddWMPrB.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmAddWMProtocols +library call + + +XmAddWMProtocols +A VendorShell convenience interface that adds the protocols to the protocol manager and allocates the internal tables + +XmAddWMProtocol\\%s + +VendorShell functions +XmAddWMProtocol\\%s + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Protocols.h> + +void XmAddWMProtocols + +Widget shell +Atom *protocols +Cardinal num_protocols + + + +DESCRIPTION +XmAddWMProtocols is a convenience interface. +It calls XmAddProtocols +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocols + +Specifies the protocol Atoms + + + + +num_protocols + +Specifies the number of elements in protocols + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddProtocols;, +&cdeman.XmInternAtom;, and +XmRemoveWMProtocols. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuA.sgm new file mode 100644 index 00000000..72d01c1e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuA.sgm @@ -0,0 +1,862 @@ + + + + + + + + + + + +XmArrowButton +library call + + +XmArrowButton +The ArrowButton widget class + +XmArrowButton + +widget class +ArrowButton + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/ArrowB.h> + + + +DESCRIPTION +ArrowButton consists of a directional arrow surrounded by a +border shadow. When it is selected, the shadow changes +to give the appearance that the +ArrowButton has been pressed in. When the +ArrowButton is unselected, the shadow reverts to give the appearance that the +ArrowButton is released, or out. + +ArrowButton holds the XmQTactivatable trait. + + +Classes +ArrowButton inherits behavior, resources, and traits +from the Core and XmPrimitive classes. + +The class pointer is xmArrowButtonWidgetClass. + +The class name is XmArrowButton. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmArrowButton Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarrowDirection +XmCArrowDirection +unsigned char +XmARROW_UP +CSG + + +XmNdetailShadowThickness +XmCDetailShadowThickness +Dimension +2 +CSG + + +XmNdisarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmultiClick +XmCMultiClick +unsigned char +dynamic +CSG + + + + + + +XmNactivateCallback + +Specifies a list of callbacks that is called +when the ArrowButton is activated. +To activate the button, press and release BSelect +while the pointer is inside +the ArrowButton widget. Activating the ArrowButton +also disarms it. +The reason sent by this callback is XmCR_ACTIVATE. +This callback uses the XmQTactivatable trait. + + + + +XmNarmCallback + +Specifies a list of callbacks that is called +when the ArrowButton is armed. +To arm this widget, press BSelect +while the pointer is inside the ArrowButton. +The reason sent by this callback is XmCR_ARM. + + + + +XmNarrowDirection + +Sets the arrow direction. +The values for this resource are + + + +XmARROW_UP + + + +XmARROW_DOWN + + + +XmARROW_LEFT + + + +XmARROW_RIGHT + + + + + + +XmNdetailShadowThickness + +Specifies the thickness of the inside arrow shadows. The default thickness +is 2 pixels. + + + + +XmNdisarmCallback + +Specifies a list of callbacks that is called +when the ArrowButton is disarmed. +To disarm this widget, press and release +BSelect while the pointer is inside the ArrowButton. +The reason for this callback is XmCR_DISARM. + + + + +XmNmultiClick + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, and this resource is +set to XmMULTICLICK_DISCARD, the second click. +is not processed. +If this resource is set to XmMULTICLICK_KEEP, the event +is processed and click_count is incremented in the callback structure. +When the button is not in a menu, the default value is +XmMULTICLICK_KEEP. + + + + + + +Inherited Resources +ArrowButton inherits behavior and resources from the +superclasses described in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int click_count; +} XmArrowButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +click_count + +This value is valid only when the reason is XmCR_ACTIVATE. +It contains the number of clicks in the last multiclick sequence +if the XmNmultiClick resource is set to XmMULTICLICK_KEEP; +otherwise it contains 1. +The activate callback is invoked for each click if XmNmultiClick +is set to XmMULTICLICK_KEEP. + + + + + + + + + + + + + + + + +Translations +XmArrowButton includes translations for XmPrimitive. +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +EnterWindow: + +Enter() + + + + +LeaveWindow: + +Leave() + + + + +c<Btn1Down>: + +ButtonTakeFocus() + + + + +≈cBtn1Down: + +Arm() + + + + +≈cBtn1Down,≈cBtn1Up: + +Activate() Disarm() + + + + +≈cBtn1Down(2+): + +MultiArm() + + + + +≈cBtn1Up(2+): + +MultiActivate() + + + + +≈cBtn1Up: + +Activate() Disarm() + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfHelp: + +Help() + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Action Routines +The XmArrowButton action routines are + + + +Activate(): + +Draws the shadow in the unselected state. +If the pointer is within the ArrowButton, +calls the callbacks for XmNactivateCallback. + + + + +Arm(): + +Draws the shadow in the selected state and +calls the callbacks for XmNarmCallback. + + + + +ArmAndActivate(): + +Draws the shadow in the selected state and +calls the callbacks for XmNarmCallback. +Arranges for the shadow to be drawn in the unselected state and +the callbacks for XmNactivateCallback and XmNdisarmCallback +to be called, either immediately or at a later time. + + + + +ButtonTakeFocus(): + +Causes the ArrowButton to take keyboard focus +when Ctrl<Btn1Down> is pressed, without activating the widget. + + + + +Disarm(): + +Draws the shadow in the unselected state and +calls the callbacks for XmNdisarmCallback. + + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +MultiActivate(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +increments click_count in the callback structure and +draws the shadow in the unselected state. +If the pointer is within the ArrowButton, this action calls the +callbacks for XmNactivateCallback and XmNdisarmCallback. + + + + +MultiArm(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. +If XmNmultiClick is XmMULTICLICK_KEEP, this action +draws the shadow in the selected state and calls the callbacks for +XmNarmCallback. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +EnterWindow: + +Draws the ArrowButton shadow in its selected state if the +pointer leaves and re-enters the window while Btn1 is pressed. + + + + +LeaveWindow: + +Draws the ArrowButton shadow in its unselected state +if the pointer leaves the window while Btn1 is pressed. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCreateArrowButton;, and &cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuB.sgm new file mode 100644 index 00000000..0953ec45 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ArrowBuB.sgm @@ -0,0 +1,641 @@ + + + + + + + + + + + +XmArrowButtonGadget +library call + + +XmArrowButtonGadget +The ArrowButtonGadget widget class + +XmArrowButtonGadget + +widget class +ArrowButtonGadget + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/ArrowBG.h> + + + +DESCRIPTION +ArrowButtonGadget consists of a directional arrow surrounded by a border shadow. +When it is selected, the shadow changes to give the appearance that the +ArrowButtonGadget has been pressed in. When it is unselected, the +shadow reverts to give the appearance that the button is released, or out. + +ArrowButtonGadget holds the XmQTactivatable trait. + + +Classes +ArrowButtonGadget inherits behavior, resources, and traits +from the Object, RectObj, and XmGadget classes. + +The class pointer is xmArrowButtonGadgetClass. + +The class name is XmArrowButtonGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmArrowButtonGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarrowDirection +XmCArrowDirection +unsigned char +XmARROW_UP +CSG + + +XmNdetailShadowThickness +XmCDetailShadowThickness +Dimension +2 +CSG + + +XmNdisarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmultiClick +XmCMultiClick +unsigned char +dynamic +CSG + + + + + + +XmNactivateCallback + +Specifies a list of callbacks that is called +when the ArrowButtonGadget is activated. +To activate the button, press and release +BSelect while the pointer is inside +the ArrowButtonGadget. Activating the ArrowButtonGadget +also disarms it. +The reason sent by this callback is XmCR_ACTIVATE. +This callback uses the XmQTactivatable trait. + + + + +XmNarmCallback + +Specifies a list of callbacks that is called +when the ArrowButtonGadget is armed. +To arm this widget, press BSelect +while the pointer is inside the ArrowButtonGadget. +The reason sent by this callback is XmCR_ARM. + + + + +XmNarrowDirection + +Sets the arrow direction. +The values for this resource are + + + +XmARROW_UP + + + +XmARROW_DOWN + + + +XmARROW_LEFT + + + +XmARROW_RIGHT + + + + + + +XmNdetailShadowThickness + +Specifies the thickness of the inside arrow shadows. The default thickness +is 2 pixels. + + + + +XmNdisarmCallback + +Specifies a list of callbacks that is called +when the ArrowButtonGadget is disarmed. +To disarm this widget, press and release BSelect +while the pointer is inside the ArrowButtonGadget. +The reason sent by this callback is XmCR_DISARM. + + + + +XmNmultiClick + +If a button click is followed by another button click within the time +span specified by the display's multiclick time and this resource is +set to XmMULTICLICK_DISCARD, the second click is not processed. +If this resource is set to XmMULTICLICK_KEEP, the event +is processed and click_count is incremented in the callback structure. +When the ArrowButtonGadget is not in a menu, the default value is +XmMULTICLICK_KEEP. + + + + + + +Inherited Resources +XmArrowButtonGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int click_count; +} XmArrowButtonCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +click_count + +This value is valid only when the reason is XmCR_ACTIVATE. +It contains the number of clicks in the last multiclick sequence +if the XmNmultiClick resource is set to XmMULTICLICK_KEEP, +otherwise it contains 1. +The activate callback is invoked for each click if XmNmultiClick +is set to XmMULTICLICK_KEEP. + + + + + + + + + + + + + + + + +Behavior +XmArrowButtonGadget includes behavior from XmGadget. +The following list describes additional +XmArrowButtonGadget behavior: + + + +Btn1Down: + +Draws the shadow in the selected state and +calls the callbacks for XmNarmCallback. + + + + +Btn1Down or Btn1Up: + +Draws the shadow in the unselected state. +If the pointer is within the ArrowButtonGadget, +calls the callbacks for XmNactivateCallback. +Calls the callbacks for XmNdisarmCallback. + + + + +Btn1Down(2+): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. +If XmNmultiClick is XmMULTICLICK_KEEP, this action +draws the shadow in the selected state and calls the callbacks for +XmNarmCallback. + + + + +Btn1Up(2+): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +increments click_count in the callback structure and +draws the shadow in the unselected state. +If the pointer is within the ArrowButtonGadget, this action calls the +callbacks for XmNactivateCallback and XmNdisarmCallback. + + + + +KeyosfSelect: + +Draws the shadow in the selected state and +calls the callbacks for XmNarmCallback. +Arranges for the shadow to be drawn in the unselected state and +the callbacks for XmNactivateCallback and XmNdisarmCallback +to be called, either immediately or at a later time. + + + + +KeyosfHelp: + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the help +callbacks for the nearest ancestor that has them. + + + + +Enter: + +Draws the ArrowButtonGadget shadow in its selected state if the +pointer leaves and re-enters the gadget while <Btn1> is pressed. + + + + +Leave: + +Draws the ArrowButtonGadget shadow in its unselected state +if the pointer leaves the gadget while <Btn1> is pressed. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Object;, &cdeman.RectObj;, +&cdeman.XmCreateArrowButtonGadget;, and +&cdeman.XmGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/BulletB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/BulletB.sgm new file mode 100644 index 00000000..71a042df --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/BulletB.sgm @@ -0,0 +1,1121 @@ + + + + + + + + + + + +XmBulletinBoard +library call + + +XmBulletinBoard +The BulletinBoard widget class + +XmBulletinBoard + +widget class +BulletinBoard + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/BulletinB.h> + + + +DESCRIPTION +BulletinBoard is a composite widget that provides simple geometry +management for child widgets. +It does not force positioning on its children, but can be set to reject +geometry requests that result in overlapping children. +BulletinBoard is the base widget for most dialog widgets and is also used +as a general container widget. + +Modal and modeless dialogs are implemented as collections of widgets that +include a DialogShell, a BulletinBoard (or subclass) child of the shell, +and various dialog components (buttons, labels, and so on) that are children +of BulletinBoard. +BulletinBoard defines callbacks useful for dialogs (focus, map, unmap), +which are available for application use. +If its parent is a DialogShell, BulletinBoard passes title and input mode +(based on dialog style) +information to the parent, which is responsible for appropriate communication +with the window manager. + +The default value for XmNinitialFocus is the value of +XmNdefaultButton. + +BulletinBoard uses the XmQTtakesDefault trait, and +holds the XmQTdialogShellSavvy and XmQTspecifyRenderTable +traits. + + +Classes +BulletinBoard inherits behavior, resources, and traits +from the Core, Composite, Constraint, +and XmManager classes. + +The class pointer is xmBulletinBoardWidgetClass. + +The class name is XmBulletinBoard. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +True +CG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +NULL +SG + + +XmNdefaultButton +XmCWidget +Widget +NULL +SG + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +True +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +XmNallowOverlap + +Controls the policy for overlapping child widgets. +If this resource is True, BulletinBoard allows geometry requests that result +in overlapping children. + + + + +XmNautoUnmanage + +Controls whether or not BulletinBoard is automatically unmanaged after a +button is activated. +If this resource is True on initialization and if the BulletinBoard's +parent is a DialogShell, BulletinBoard adds a callback to button +children (PushButtons, PushButtonGadgets, and DrawnButtons) that +unmanages the BulletinBoard when a button is activated. +If this resource is False on initialization or if the BulletinBoard's +parent is not a DialogShell, the +BulletinBoard is not automatically unmanaged. +For BulletinBoard subclasses with Apply or Help buttons, activating +those buttons does not automatically unmanage the BulletinBoard. + + + + +XmNbuttonFontList + +Specifies the font list used for button descendants. See the +XmNbuttonRenderTable resource. + + + + +XmNbuttonRenderTable + +Specifies the render table used for BulletinBoard's button descendants. +If this value is NULL at initialization, the parent hierarchy of the widget +is searched for an ancestor that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the render table is initialized to the +XmBUTTON_RENDER_TABLE value of the ancestor widget. If no such +ancestor is +found, the default is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNcancelButton + +Specifies the widget ID of the Cancel button. BulletinBoard's +subclasses, which define a Cancel button, +set this resource. BulletinBoard does not directly provide any behavior for +that button. + + + + +XmNdefaultButton + +Specifies the widget ID of the default button. +Some BulletinBoard subclasses, which define a default button, +set this resource. BulletinBoard defines translations and installs +accelerators that activate that button when KActivate is pressed +and the keyboard focus is not in another button. +Controls the positioning of a DialogShell managing a BulletinBoard. +If the BulletinBoard is not being managed by a DialogShell, then +this resource has no effect. If XmNdefaultPosition is True, +the DialogShell will center itself at the center of its own parent. +For example, if the parent of the DialogShell is an ApplicationShell, +then the center of the DialogShell will be at the same coordinates +as the center of the ApplicationShell. +If the DialogShell becomes unmapped (but stays managed) and then remapped, +this resource has no influence on the DialogShell's position. +If this resource is False, the DialogShell does not automatically +center itself. + + + + +XmNdialogStyle + +Indicates the dialog style associated with the BulletinBoard. +If the parent of the BulletinBoard is a DialogShell, the parent's +XmNmwmInputMode is set according to the value of this resource. +This resource can be set only if the BulletinBoard is unmanaged. +Possible values for this resource include the following: + + + +XmDIALOG_SYSTEM_MODAL + +Used for dialogs that +must be responded to before +any other interaction in any application. + + + + +XmDIALOG_PRIMARY_APPLICATION_MODAL + +Used for dialogs that must +be responded to before some other interactions in +ancestors of the widget. + + + + +XmDIALOG_APPLICATION_MODAL + +Used for dialogs that must be +responded to before some other interactions in +ancestors of the widget. This value is the same as +XmDIALOG_PRIMARY_APPLICATION_MODAL, and remains for compatibility. + + + + +XmDIALOG_FULL_APPLICATION_MODAL + +Used for dialogs that must be +responded to before some other interactions in +the same application. + + + + +XmDIALOG_MODELESS + +Used for dialogs that do not interrupt interaction +of any application. +This is the default when the parent of the BulletinBoard is a DialogShell. + + + + +XmDIALOG_WORK_AREA + +Used for BulletinBoard widgets whose +parents are not DialogShells. +XmNdialogStyle is forced to have this value when the parent of the +BulletinBoard is not a DialogShell. + + + + +Posting a modal dialog in response to a button down or key down event +(via translation actions or callbacks) can cause the corresponding +button up or key up event to be lost. For example, posting a modal +dialog from an XmNincrementCallback of XmScrollBar will cause +the loss of the button up event, causing the XmScrollBar to +auto-increment indefinitely. + + + + +XmNdialogTitle + +Specifies the dialog title. If this resource is not NULL, and the parent +of the BulletinBoard is a subclass of WMShell, BulletinBoard sets the +XmNtitle and XmNtitleEncoding of its parent. +If the only character set in XmNdialogTitle is ISO8859-1, +XmNtitle is set to the string of the title, and +XmNtitleEncoding is set to STRING. +If XmNdialogTitle contains character sets other than ISO8859-1, +XmNtitle is set to the string of the title converted to a compound +text string, and XmNtitleEncoding is set to COMPOUND_TEXT. +The direction of the title is based on the XmNlayoutDirection resource +of the widget. + + + + +XmNfocusCallback + +Specifies the list of callbacks that is called +when the BulletinBoard widget or one of its +descendants accepts the input focus. +The callback reason is XmCR_FOCUS. + + + + +XmNlabelFontList + +Specifies the font list used for label descendants. See the +XmNlabelRenderTable resource. + + + + +XmNlabelRenderTable + +Specifies the render table used for BulletinBoard's label descendants. +If this value is NULL at initialization, the parent hierarchy of the widget +is searched for an ancestor that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the render table is initialized to the +XmLABEL_RENDER_TABLE value of the ancestor widget. If no such +ancestor is +found, the default is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNmapCallback + +Specifies the list of callbacks that is called +only when the parent of the BulletinBoard is a DialogShell. In this case, +this callback list is invoked when the BulletinBoard widget is mapped. +The callback reason is XmCR_MAP. +DialogShells are usually mapped when the DialogShell is managed. + + + + +XmNmarginHeight + +Specifies the minimum spacing in pixels between the top or bottom edge +of BulletinBoard and any child widget. + + + + +XmNmarginWidth + +Specifies the minimum spacing in pixels between the left or right edge +of BulletinBoard and any child widget. + + + + +XmNnoResize + +Controls whether or not resize controls are included in the window +manager frame around the BulletinBoard's parent. +If this resource is +set to True, mwm does not include resize controls in the +window manager frame containing the parent of the BulletinBoard if the +parent is a subclass of VendorShell. +If this resource is set to False, +the window manager frame does include resize controls. +Other controls provided by mwm can be included or excluded through +the mwm resources provided by VendorShell. + + + + +XmNresizePolicy + +Controls the policy for resizing BulletinBoard widgets. +Possible values include + + + +XmRESIZE_NONE + +Fixed size + + + + +XmRESIZE_ANY + +Shrink or grow as needed + + + + +XmRESIZE_GROW + +Grow only + + + + + + + +XmNshadowType + +Describes the shadow +drawing style for BulletinBoard. This resource can have the +following values: + + + +XmSHADOW_IN + +Draws the BulletinBoard shadow +so that it appears inset. +This means that the bottom shadow visuals and top shadow visuals +are reversed. + + + + +XmSHADOW_OUT + +Draws the BulletinBoard shadow +so that it appears outset. + + + + +XmSHADOW_ETCHED_IN + +Draws the BulletinBoard shadow +using a double line giving the +effect of a line etched into the window, similar to the Separator widget. + + + + +XmSHADOW_ETCHED_OUT + +Draws the BulletinBoard shadow using a double +line giving the +effect of a line coming out of the window, similar to the Separator widget. + + + + + + + +XmNtextFontList + +Specifies the font list used for text descendants. See the +XmNtextRenderTable resource. + + + + +XmNtextRenderTable + +Specifies the render table used for BulletinBoard's text descendants. +If this value is NULL at initialization, the parent hierarchy of the widget +is searched for an ancestor that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the render table is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such +ancestor is +found, the default is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNtextTranslations + +It adds translations to any Text widget or Text widget subclass that +is added as a child of BulletinBoard. + + + + +XmNunmapCallback + +Specifies the list of callbacks that is called only when the parent of +the BulletinBoard is a DialogShell. +In this case, this callback list is invoked when the BulletinBoard +widget is unmapped. +The callback reason is XmCR_UNMAP. +DialogShells are usually unmapped when the DialogShell is unmanaged. + + + + + + +Inherited Resources +BulletinBoard inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + + + + + + + + + + + + + +Translations +XmBulletinBoard includes the translations from XmManager. + + + +Additional Behavior +The XmBulletinBoard widget has the following additional behavior: + + + +KeyosfCancel: + +Calls the activate callbacks for the cancel button if it is sensitive. +If no cancel button exists and if the parent of the BulletinBoard is +a manager, passes the event to the parent. + + + + +KeyosfActivate: + +Calls the activate callbacks for the button with the keyboard focus. +If no button has the keyboard focus, calls the activate callbacks +for the default button if it is sensitive. +In a List widget or single-line Text widget, +the List or Text action associated with KeyosfActivate +is called before the BulletinBoard actions associated with +KeyosfActivate. + +In a multiline Text widget, any KeyosfActivate +event except KeyEnter calls +the Text action associated with KeyosfActivate, +then the BulletinBoard actions associated with KeyosfActivate. +If no button has the focus, no default button exists, and the parent of the +BulletinBoard is a manager, passes the event to the parent. + + + + +FocusIn: + +Calls the callbacks for XmNfocusCallback. +When the focus policy is XmPOINTER, the callbacks are +called when the pointer +enters the window. +When the focus policy is XmEXPLICIT, the callbacks are called +when the user traverses to the widget. + + + + +Map: + +Calls the callbacks for XmNmapCallback. + + + + +Unmap: + +Calls the callbacks for XmNunmapCallback. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, +&cdeman.Core;, &cdeman.XmCreateBulletinBoard;, +&cdeman.XmCreateBulletinBoardDialog;, +&cdeman.XmDialogShell;, and &cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBA.sgm new file mode 100644 index 00000000..8d571563 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBA.sgm @@ -0,0 +1,1165 @@ + + + + + + + + + + + +XmCascadeButton +library call + + +XmCascadeButton +The CascadeButton widget class + +XmCascadeButton + +widget class +CascadeButton + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/CascadeB.h> + + + +DESCRIPTION +CascadeButton links two menu panes or a MenuBar to a menu pane. + +It is used in menu systems and must have a RowColumn parent +with its XmNrowColumnType resource set to XmMENU_BAR, +XmMENU_POPUP or XmMENU_PULLDOWN. + +It is the only widget that can have a Pulldown menu pane attached to it as +a submenu. The submenu is displayed when this widget is activated within +a MenuBar, a PopupMenu, or a PulldownMenu. Its visuals can +include a label or pixmap and a cascading indicator when it is in a +Popup or Pulldown menu pane; or it can include only a label or a pixmap +when it is in a MenuBar. +The positioning of the PulldownMenu with respect to the CascadeButton +depends on the XmNlayoutDirection resource of the MenuShell. + +The default behavior associated with a CascadeButton depends on the type +of menu system in which it resides. +By default, BSelect controls the behavior of the CascadeButton. +In addition, BMenu controls the behavior of the CascadeButton if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. +BMenu also performs the BSelect actions in all +types of menu systems. + +A CascadeButton's visuals differ from most other button gadgets. When the +button +becomes armed, its visuals change from a 2-D to a 3-D look, and it displays +the submenu that has been attached +to it. If no submenu is attached, it simply changes its visuals. + +When a CascadeButton within a Pulldown or Popup menu pane +is armed as the result of the user +moving the mouse pointer into the widget, it does not immediately display its +submenu. Instead, it waits a short amount of time to see if the arming +was temporary (that is, the user was simply passing through the widget), or +whether the user really wanted the submenu posted. This time delay is +configurable using XmNmappingDelay. + +CascadeButton provides a single mechanism for +activating the widget from the keyboard. This mechanism is referred to as +a keyboard mnemonic. +If a mnemonic has been +specified for the widget, the user may activate the CascadeButton +by simply typing the mnemonic while the CascadeButton is visible. +If the CascadeButton is in a MenuBar and the MenuBar does not have the +focus, the MAlt modifier must be +pressed with the mnemonic. +Mnemonics are typically used to interact with a menu +using the keyboard interface. + +If the Cascadebutton is in a Pulldown or Popup menu pane and +there is a submenu attached, the +XmNmarginBottom, XmNmarginLeft, XmNmarginRight, and +XmNmarginTop resources may +enlarge to accommodate XmNcascadePixmap. +XmNmarginWidth defaults +to 6 if this +resource is in a MenuBar; otherwise, it takes Label's default, which +is 2. + +CascadeButton uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits. + + +Classes +CascadeButton inherits behavior, resources, and traits from Core, +XmPrimitive, and XmLabel classes. + +The class pointer is xmCascadeButtonWidgetClass. + +The class name is XmCascadeButton. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, +remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmCascadeButton Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcascadePixmap +XmCPixmap +Pixmap +dynamic +CSG + + +XmNcascadingCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmappingDelay +XmCMappingDelay +int +180 ms +CSG + + +XmNsubMenuId +XmCMenuWidget +Widget +NULL +CSG + + + + + + +XmNactivateCallback + +Specifies the list of callbacks that is called +when the user activates the CascadeButton widget +and there is no submenu attached to pop up. The activation occurs +when a mouse button is released +or when the mnemonic associated with the widget is typed. The specific mouse +button depends on information in the RowColumn parent. The reason +sent by the callback is XmCR_ACTIVATE. + + + + +XmNcascadePixmap + +Specifies the cascade pixmap displayed on one end of the widget when +a CascadeButton is used within a Popup or Pulldown menu pane and a submenu +is attached. +The Label class resources XmNmarginBottom, XmNmarginLeft, +XmNmarginRight, and XmNmarginTop may be modified to ensure +that room is left for the cascade pixmap. +The default cascade pixmap is an arrow pointing to the side of the menu +where the submenu will appear. +The positioning of the cascade pixmap +to either the left of right of the widget, and the direction of the +arrow, depend on the XmNlayoutDirection resource of the MenuShell. + + + + +XmNcascadingCallback + +Specifies the list of callbacks that is called +just prior to the mapping of the submenu associated with +CascadeButton. The reason sent by the callback is XmCR_CASCADING. + + + + +XmNmappingDelay + +Specifies the amount of time, in milliseconds, between when a CascadeButton +becomes armed and when it maps its submenu. This delay is used only when +the widget is within a Popup or Pulldown menu pane. +The value must not be negative. + + + + +XmNsubMenuId + +Specifies the widget ID for the Pulldown menu pane to be associated with +this CascadeButton. The specified menu pane is displayed +when the CascadeButton becomes armed. The menu pane must have been created +with the appropriate parentage depending on the type of menu used. See +&cdeman.XmCreateMenuBar;, &cdeman.XmCreatePulldownMenu;, and +&cdeman.XmCreatePopupMenu; for more information on the menu systems. + + + + + + +Inherited Resources +CascadeButton inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabel Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +N/A + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +N/A + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +0 +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +dynamic +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +dynamic +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +dynamic +G + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback or is NULL +if this callback was not triggered due to an XEvent + + + + + + + + + + + + + + + + +Translations +XmCascadeButton includes translations from XmPrimitive. +XmCascadeButton includes the menu traversal translations from XmLabel. + +Note that altering translations in #override +or #augment mode is undefined. + +The following list describes the translations for a +CascadeButton in a MenuBar. +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +EnterWindowNormal: + +MenuBarEnter() + + + + +LeaveWindowNormal: + +MenuBarLeave() + + + + +Btn2Down: + +ProcessDrag() + + + + +c<BtnDown>: + +MenuButtonTakeFocusUp() + + + + +c<BtnUp>: + +MenuButtonTakeFocusUp() + + + + +≈cBtnDown: + +MenuBarSelect() + + + + +≈cBtnUp: + +DoSelect() + + + + +:KeyosfSelect: + +KeySelect() + + + + +:KeyosfActivate: + +KeySelect() + + + + +:KeyosfHelp: + +Help() + + + + +:KeyosfCancel: + +CleanupMenuBar() + + + + +≈sKeyReturn: + +KeySelect() + + + + +≈sKeyspace: + +KeySelect() + + + + + +The following list describes the translations for a +CascadeButton in a PullDown or Popup MenuPane. +In a Popup menu system, Btn3 also performs the +Btn1 actions. + + + +EnterWindow: + +DelayedArm() + + + + +LeaveWindow: + +CheckDisarm() + + + + +Btn2Down: + +ProcessDrag() + + + + +c<BtnDown>: + +MenuButtonTakeFocus() + + + + +c<BtnUp>: + +MenuButtonTakeFocusUp() + + + + +≈cBtnDown: + +StartDrag() + + + + +≈cBtnUp: + +DoSelect() + + + + +:KeyosfSelect: + +KeySelect() + + + + +:KeyosfActivate: + +KeySelect() + + + + +:KeyosfHelp: + +Help() + + + + +:KeyosfCancel: + +CleanupMenuBar() + + + + +≈sKeyReturn: + +KeySelect() + + + + +≈sKeyspace: + +KeySelect() + + + + + + + +Action Routines +The XmCascadeButton action routines are + + + +CleanupMenuBar(): + +In a MenuBar, disarms the CascadeButton and the menu and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores +keyboard focus to the widget that had the focus before the menu was +entered. + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to the +widget from which the menu was posted. + + + + +DoSelect(): + +Calls the callbacks in XmNcascadingCallback, +posts the submenu attached to the CascadeButton and +enables keyboard traversal within the menu. +If the CascadeButton does not have a submenu attached, +this action calls the callbacks in XmNactivateCallback, +activates the CascadeButton, and unposts all posted menus in the cascade. + + + + +Help(): + +Unposts all menus in the menu hierarchy and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to +the widget that had the focus before the menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +KeySelect(): + +Calls the callbacks in XmNcascadingCallback, +and posts the submenu attached to the CascadeButton if keyboard +traversal is enabled in the menu. +If the CascadeButton does not have a submenu attached, +this action calls the callbacks in XmNactivateCallback, +activates the CascadeButton, and unposts all posted menus in the cascade. + + + + +MenuBarSelect(): + +Unposts any menus posted by the parent menu. +Arms both the CascadeButton and the MenuBar, +posts the associated submenu, and enables mouse traversal. +If the menu is already active, this event +disables keyboard traversal for the menu and returns +the menu to mouse traversal mode. + + + + +StartDrag(): + +Arms the CascadeButton, posts the associated submenu, and enables mouse +traversal. +If the menu is already active, this event +disables keyboard traversal for the menu and returns +the menu to mouse traversal mode. + + + + + + +Additional Behavior +Posting a submenu calls the XmNcascadingCallback callbacks. +This widget has the following additional behavior: + + + +EnterWindow: + +If keyboard traversal is enabled, does nothing. +Otherwise, in a MenuBar that is armed, +unposts any MenuPanes associated with another MenuBar entry, +arms the CascadeButton, and posts the associated submenu. +In other menus, +arms the CascadeButton and posts the associated submenu after +the delay specified by XmNmappingDelay. + + + + +LeaveWindow: + +If keyboard traversal is enabled does nothing. +Otherwise, in a MenuBar that is armed, +disarms the CascadeButton +if the submenu associated with the CascadeButton is not currently +posted or if there is no submenu associated with the CascadeButton. + +In other menus, +if the pointer moves anywhere except into a submenu associated with the +CascadeButton, the CascadeButton is disarmed and its submenu is unposted. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCascadeButtonHighlight;, +&cdeman.XmCreateCascadeButton;, +&cdeman.XmCreateMenuBar;, &cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreatePopupMenu;, +&cdeman.XmLabel;, &cdeman.XmPrimitive;, and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBB.sgm new file mode 100644 index 00000000..591cab9b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBB.sgm @@ -0,0 +1,874 @@ + + + + + + + + + + + +XmCascadeButtonGadget +library call + + +XmCascadeButtonGadget +The CascadeButtonGadget widget class + +XmCascadeButtonGadget + +widget class +CascadeButtonGadget + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/CascadeBG.h> + + + +DESCRIPTION +CascadeButtonGadget links two menu panes, a MenuBar to a menu pane, or an +OptionMenu to a menu pane. + +It is used in menu systems and must have a RowColumn parent +with its XmNrowColumnType resource set to XmMENU_BAR, +XmMENU_POPUP, XmMENU_PULLDOWN, or XmMENU_OPTION. + +It is the only gadget that can have a Pulldown menu pane attached to it as +a submenu. The submenu is displayed when this gadget is activated within +a PopupMenu, a PulldownMenu, or an OptionMenu. Its visuals can +include a label or pixmap and a cascading indicator when it is in a +Popup or Pulldown menu pane; or it can include only a label or a pixmap +when it is in an OptionMenu. +The positioning of the PulldownMenu with respect to the CascadeButton +depends on the XmNlayoutDirection resource of the MenuShell. + +The default behavior associated with a CascadeButtonGadget depends on the type +of menu system in which it resides. +By default, BSelect controls the behavior of the CascadeButtonGadget. +In addition, BMenu controls the behavior of the CascadeButtonGadget if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. +BMenu also performs the BSelect actions in all +types of menu systems. + +A CascadeButtonGadget's visuals differ from most other button gadgets. When +the button +becomes armed, its visuals change from a 2-D to a 3-D look, and it displays +the submenu that has been attached +to it. If no submenu is attached, it simply changes its visuals. + +When a CascadeButtonGadget +within a Pulldown or Popup menu pane is armed as the result of the user +moving the mouse pointer into the gadget, it does not immediately display its +submenu. Instead, it waits a short time to see if the arming +was temporary (that is, the user was simply passing through the gadget), or +the user really wanted the submenu posted. This delay is +configurable using XmNmappingDelay. + +CascadeButtonGadget provides a single mechanism for +activating the gadget from the keyboard. This mechanism is referred to as +a keyboard mnemonic. +If a mnemonic has been +specified for the gadget, the user may activate it +by simply typing the mnemonic while the CascadeButtonGadget is visible. +If the CascadeButtonGadget is in a MenuBar and the MenuBar does not have +focus, the MAlt modifier must be +pressed with the mnemonic. +Mnemonics are typically used to interact with a menu +using the keyboard. + +If a CascadeButtonGadget is in a Pulldown or Popup menu pane and there is a submenu attached, the +XmNmarginBottom, XmNmarginLeft, XmNmarginRight, and +XmNmarginTop +resources may enlarge to accommodate XmNcascadePixmap. +XmNmarginWidth defaults +to 6 if this +resource is in a MenuBar; otherwise, it takes LabelGadget's default, which +is 2. + +CascadeButtonGadget uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits. + + +Classes +CascadeButtonGadget inherits behavior, resources, and traits +from the Object, RectObj, XmGadget, +and XmLabelGadget classes. + +The class pointer is xmCascadeButtonGadgetClass. + +The class name is XmCascadeButtonGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmCascadeButtonGadget + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcascadePixmap +XmCPixmap +Pixmap +dynamic +CSG + + +XmNcascadingCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmappingDelay +XmCMappingDelay +int +180 ms +CSG + + +XmNsubMenuId +XmCMenuWidget +Widget +NULL +CSG + + + + + + +XmNactivateCallback + +Specifies the list of callbacks that is +called when the user activates the CascadeButtonGadget, +and there is no submenu attached to pop up. The activation occurs +when a mouse button is released +or when the mnemonic associated with the gadget is typed. The specific mouse +button depends on information in the RowColumn parent. The reason +sent by the callback is XmCR_ACTIVATE. + + + + +XmNcascadePixmap + +Specifies the cascade pixmap displayed on one end of the gadget when +a CascadeButtonGadget is used within a Popup or Pulldown menu pane +and a submenu is attached. +The LabelGadget class resources XmNmarginBottom, +XmNmarginLeft, XmNmarginRight, and +XmNmarginTop may be modified to +ensure that room is left for the cascade pixmap. +The default cascade pixmap in menus other than option menus is an arrow +pointing to the side of the menu where the submenu will appear. +The default for the CascadeButtonGadget in an option menu is +XmUNSPECIFIED_PIXMAP. + +The positioning of the cascade pixmap +to either the left of right of the widget, and the direction of the +arrow, depend on the XmNlayoutDirection resource of the MenuShell. + + + + +XmNcascadingCallback + +Specifies the list of callbacks that is +called just prior to the mapping of the submenu +associated with the +CascadeButtonGadget. The reason sent by the callback is XmCR_CASCADING. + + + + +XmNmappingDelay + +Specifies the amount of time, in milliseconds, between when a +CascadeButtonGadget +becomes armed and when it maps its submenu. This delay is used only when the +gadget is within a Popup or Pulldown menu pane. +The value must not be negative. + + + + +XmNsubMenuId + +Specifies the widget ID for the Pulldown menu pane to be +associated with this CascadeButtonGadget. The specified menu pane is +displayed when the CascadeButtonGadget becomes armed. The menu pane must +have been created with the appropriate parentage depending on the type +of menu used. See &cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreatePopupMenu;, and &cdeman.XmCreateOptionMenu; for +more information on the menu systems. + + + + + + +Inherited Resources +CascadeButtonGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabelGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +N/A + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +N/A + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +0 +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +dynamic +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +dynamic +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +dynamic +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback or is NULL if this +callback was not triggered by an XEvent + + + + + + + + + + + + + + + + +Behavior +XmCascadeButtonGadget includes behavior from XmGadget. +XmCascadeButton includes the menu traversal behavior from XmLabel. +Additional XmCascadeButtonGadget behavior is described in +the following list (in a Popup +menu system, Btn3 also performs the Btn1 actions). + + + +Btn1Down: + +Unposts any menus posted by the parent menu. +Arms the CascadeButtonGadget, +posts the associated submenu, +enables mouse traversal, +and, in a MenuBar, arms the MenuBar. +If the menu is already active, this event +disables keyboard traversal for the menu and returns +the menu to mouse traversal mode. + + + + +Btn1Up: + +Calls the callbacks in XmNcascadingCallback, +posts the submenu attached to the CascadeButtonGadget and +enables keyboard traversal within the menu. +If the CascadeButtonGadget does not have a submenu attached, +this action calls the callbacks in XmNactivateCallback, +activates the CascadeButtonGadget, and unposts +all posted menus in the cascade. + + + + +KeyosfActivate: + +Calls the callbacks in XmNcascadingCallback, +and +posts the submenu attached to the CascadeButtonGadget if keyboard +traversal is enabled in the menu. +If the CascadeButtonGadget does not have a submenu attached, +this action calls the callbacks in XmNactivateCallback, +activates the CascadeButtonGadget, and unposts +all posted menus in the cascade. +This action applies only to gadgets in MenuBars, PulldownMenus, and +PopupMenus. For a CascadeButtonGadget in an OptionMenu, if the parent +is a manager, this action passes the event to the parent. + + + + +KeyosfSelect: + +Calls the callbacks in XmNcascadingCallback, +and +posts the submenu attached to the CascadeButtonGadget if keyboard +traversal is enabled in the menu. +If the CascadeButtonGadget does not have a submenu attached, +this action calls the callbacks in XmNactivateCallback, +activates the CascadeButtonGadget, and unposts all posted +menus in the cascade. + + + + +KeyosfHelp: + +Unposts all menus in the menu hierarchy and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to +the widget that had the focus before the menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +KeyosfCancel: + +In a MenuBar, disarms the CascadeButtonGadget and the menu and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores +keyboard focus to the widget that had the focus before the menu was +entered. +For a CascadeButtonGadget in an OptionMenu, if the parent is a manager, this +action passes the event to the parent. + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and restores keyboard focus to the +widget from which the menu was posted. + + + + +Enter: + +If keyboard traversal is enabled does nothing. +Otherwise, in a MenuBar, +unposts any MenuPanes associated with another MenuBar entry, +arms the CascadeButtonGadget, and posts the associated submenu. +In other menus, +arms the CascadeButtonGadget and posts the associated submenu after +the delay specified by XmNmappingDelay. + + + + +Leave: + +If keyboard traversal is enabled does nothing. +Otherwise, in a MenuBar, +disarms the CascadeButtonGadget +if the submenu associated with the CascadeButtonGadget is not currently +posted or if there is no submenu associated with the CascadeButtonGadget. + +In other menus, if the pointer moves anywhere except into a submenu +associated with the CascadeButtonGadget, the CascadeButtonGadget is +disarmed and its submenu is unposted. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Object;, &cdeman.RectObj;, +&cdeman.XmCascadeButtonHighlight;, +&cdeman.XmCreateCascadeButtonGadget;, +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreateOptionMenu;, +&cdeman.XmGadget;, &cdeman.XmLabelGadget;, +and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBC.sgm new file mode 100644 index 00000000..85a8e2b0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBC.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmCascadeButtonGadgetHighlight +library call + + +XmCascadeButtonGadgetHighlight +A CascadeButtonGadget function that sets the highlight state + +XmCascadeButtonGadget\\%Highlight + +CascadeButtonGadget functions +XmCascadeButtonGadget\\%Highlight + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CascadeBG.h> + +void XmCascadeButtonGadgetHighlight + +Widget cascadeButtonGadget +Boolean highlight + + + +DESCRIPTION +XmCascadeButtonGadgetHighlight either draws or erases the shadow +highlight around the CascadeButtonGadget. + + + +cascadeButtonGadget + +Specifies the CascadeButtonGadget to be highlighted +or unhighlighted + + + + +highlight + +Specifies whether to highlight (True) or to unhighlight (False) + + + + +For a complete definition of +CascadeButtonGadget and its associated resources, see +&cdeman.XmCascadeButtonGadget;. + + + +RELATED +&cdeman.XmCascadeButton;, +&cdeman.XmCascadeButtonGadget;, +and +&cdeman.XmCascadeButtonHighlight;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBD.sgm new file mode 100644 index 00000000..f0774cd5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CascBD.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmCascadeButtonHighlight +library call + + +XmCascadeButtonHighlight +A CascadeButton and CascadeButtonGadget function that sets the highlight state + +XmCascadeButtonHighlight + +CascadeButton functions +XmCascadeButtonHighlight + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CascadeB.h> +#include <Xm/CascadeBG.h> + +void XmCascadeButtonHighlight + +Widget cascadeButton +Boolean highlight + + + +DESCRIPTION +XmCascadeButtonHighlight either draws or erases the shadow +highlight around the CascadeButton or the CascadeButtonGadget. + + + +cascadeButton + +Specifies the CascadeButton or CascadeButtonGadget to be highlighted +or unhighlighted + + + + +highlight + +Specifies whether to highlight (True) or to unhighlight (False) + + + + +For a complete definition of CascadeButton +or CascadeButtonGadget and their associated resources, see +&cdeman.XmCascadeButton; or &cdeman.XmCascadeButtonGadget;. + + + +RELATED +&cdeman.XmCascadeButton;, +&cdeman.XmCascadeButtonGadget; +and +&cdeman.XmCascadeButtonGadgetHighlight;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ChangeCo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ChangeCo.sgm new file mode 100644 index 00000000..3970d40b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ChangeCo.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmChangeColor +library call + + +XmChangeColor +Recalculates all associated colors of +a widget + +XmChangeColor + +Color functions +XmChangeColor + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmChangeColor + +Widget widget +Pixel background + + + +DESCRIPTION +XmChangeColor handles all color modifications for the +specified widget when a new background pixel value is specified. +This function recalculates the foreground, select, and shadow +colors based on the new background color and sets the corresponding +resources for the widget. If a color calculation procedure has +been set by a call to XmSetColorCalculation, XmChangeColor +uses that procedure to calculate the new colors. Otherwise, the +routine uses a default procedure. + + + +widget + +Specifies the widget ID whose colors will be updated + + + + +background + +Specifies the background color pixel value + + + + + + +RELATED +&cdeman.XmGetColorCalculation;, +&cdeman.XmGetColors;, and +&cdeman.XmSetColorCalculation;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbA.sgm new file mode 100644 index 00000000..60e8a039 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbA.sgm @@ -0,0 +1,145 @@ + + + + + + + + + + + +XmClipboardCancelCopy +library call + + +XmClipboardCancelCopy +A clipboard function that cancels a copy to the clipboard + +XmClipboardCancelCopy + +clipboard functions +XmClipboardCancelCopy + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardCancelCopy (display, window, item_id) + Display * display; + Window window; + long item_id; + + + + + + +DESCRIPTION +XmClipboardCancelCopy +cancels the copy to clipboard that is in progress and +frees up temporary storage. +When a copy is to be performed, XmClipboardStartCopy allocates +temporary storage for the clipboard data. XmClipboardCopy copies +the appropriate data into the the temporary storage. XmClipboardEndCopy +copies the data to the clipboard structure and frees up the temporary +storage structures. +If XmClipboardCancelCopy is called, the +XmClipboardEndCopy function does not have to be called. A call to +XmClipboardCancelCopy +is valid only after a call to +XmClipboardStartCopy. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies a widget's window ID that +relates the application window to the clipboard. +The widget's window ID can be obtained through XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +item_id + +Specifies the number assigned to this data item. This number was returned +by a previous call to XmClipboardStartCopy. + + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardFail + +The function failed because XmClipboardStartCopy was not called or +because the data item contains too many formats. + + + + + + +RELATED +&cdeman.XmClipboardCopy;, +&cdeman.XmClipboardEndCopy;, and &cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbB.sgm new file mode 100644 index 00000000..cdf14f3c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbB.sgm @@ -0,0 +1,207 @@ + + + + + + + + + + + +XmClipboardCopy +library call + + +XmClipboardCopy +A clipboard function that copies a data item to temporary storage for later copying to clipboard + +XmClipboardCopy + +clipboard functions +XmClipboardCopy + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardCopy (display, window, item_id, format_name, + buffer, length, private_id, data_id) + Display * display; + Window window; + long item_id; + char * format_name; + XtPointer buffer; + unsigned long length; + long private_id; + long * data_id; + + + + + + +DESCRIPTION +XmClipboardCopy +copies a data item to temporary storage. +The data item is moved from temporary storage +to the clipboard data structure when a +call to XmClipboardEndCopy is made. +Additional calls to XmClipboardCopy before a call to +XmClipboardEndCopy add +additional data item formats to the same data item or +append data to an existing format. Formats are described in the +Inter-Client Communication Conventions Manual (ICCCM) as targets. + +NOTE: Do not call XmClipboardCopy before a call to +XmClipboardStartCopy has been made. The latter function allocates +temporary storage required by XmClipboardCopy. + +If the buffer argument is NULL, the data is considered +to be passed by name. +When data that +has been passed by name is later requested by another application, the +application that owns the data receives a callback with a request for +the data. The application that owns the data must then transfer the +data to the clipboard with the XmClipboardCopyByName function. +When a data item that was passed by name is deleted +from the clipboard, the application that owns the data receives a +callback stating that the data is no longer needed. + +For information on the callback function, see the callback argument +description for XmClipboardStartCopy. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +item_id + +Specifies the number assigned to this data item. +This number was returned by a previous call to +XmClipboardStartCopy. + + + + +format_name + +Specifies the name of the format in which the data item +is stored on the clipboard. The format was known as target in the ICCCM. + + + + +buffer + +Specifies the buffer from which the clipboard copies the data. + + + + +length + +Specifies the +length, in bytes, +of the data being copied to the clipboard. + + + + +private_id + +Specifies the private data that the application wants +to store with the data item. + + + + +data_id + +Specifies an identifying number assigned to the data item that uniquely +identifies the data item and the format. +This argument is required only for data that is passed by name. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardFail + +The function failed because XmClipboardStartCopy was not called or +because the data item contains too many formats. + + + + + + +RELATED +&cdeman.XmClipboardCopyByName;, +&cdeman.XmClipboardEndCopy;, and +&cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbC.sgm new file mode 100644 index 00000000..ffb17e80 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbC.sgm @@ -0,0 +1,155 @@ + + + + + + + + + + + +XmClipboardCopyByName +library call + + +XmClipboardCopyByName +A clipboard function that copies a data item passed by name + +XmClipboardCopyByName + +clipboard functions +XmClipboardCopyByName + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardCopyByName (display, window, data_id, + buffer, length, private_id) + Display * display; + Window window; + long data_id; + XtPointer buffer; + unsigned long length; + long private_id; + + + + + + +DESCRIPTION +XmClipboardCopyByName copies the actual data for a data item +that was previously passed by name to the clipboard. Data is +considered to be passed by name when a call to XmClipboardCopy +is made with a NULL buffer parameter. Additional calls to this +function append new data to the existing data. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each +clipboard function it calls. + + + + +data_id + +Specifies an identifying number assigned to the data item that uniquely +identifies the data item and the format. This number was assigned by +XmClipboardCopy to the data item. + + + + +buffer + +Specifies the buffer from which the clipboard copies the data. + + + + +length + +Specifies the number of bytes in the data item. + + + + +private_id + +Specifies the private data that the application wants to store with the +data item. + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardCopy;, &cdeman.XmClipboardLock;, +&cdeman.XmClipboardStartCopy;, and &cdeman.XmClipboardUnlock;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbD.sgm new file mode 100644 index 00000000..fd89d84d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbD.sgm @@ -0,0 +1,142 @@ + + + + + + + + + + + +XmClipboardEndCopy +library call + + +XmClipboardEndCopy +A clipboard function that completes the +copying of data to the clipboard + +XmClipboardEndCopy + +clipboard functions +XmClipboardEndCopy + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardEndCopy (display, window, item_id) + Display * display; + Window window; + long item_id; + + + + + + +DESCRIPTION +XmClipboardEndCopy locks the clipboard from access by other applications, +places data in the clipboard data structure, and unlocks the clipboard. +Data items copied to the clipboard by XmClipboardCopy are not actually +entered in the clipboard data structure until the call to +XmClipboardEndCopy. + +This function also frees up temporary storage that was allocated by +XmClipboardStartCopy, which must be called before +XmClipboardEndCopy. The latter function should not be called if +XmClipboardCancelCopy has been called. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each +clipboard function it calls. + + + + +item_id + +Specifies the number assigned to this data item, which was returned +by a previous call to XmClipboardStartCopy. + + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardFail + +The function failed because XmClipboardStartCopy was not called. + + + + + + +RELATED +&cdeman.XmClipboardCancelCopy;, +&cdeman.XmClipboardCopy; and &cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbE.sgm new file mode 100644 index 00000000..8f9deeb2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbE.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmClipboardEndRetrieve +library call + + +XmClipboardEndRetrieve +A clipboard function that completes +retrieval of data from the clipboard + +XmClipboardEndRetrieve + +clipboard functions +XmClipboardEndRetrieve + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardEndRetrieve (display, window) + Display * display; + Window window; + + + + + + +DESCRIPTION +XmClipboardEndRetrieve suspends copying data incrementally from +the clipboard. It tells the clipboard routines that the application +is through copying an item from the clipboard. Until this function is +called, data items can be retrieved incrementally from the clipboard +with XmClipboardRetrieve. +The act of copying data is started with the +XmClipboardStartRetrieve function. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained with +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardRetrieve;, &cdeman.XmClipboardStartCopy;, and +&cdeman.XmClipboardStartRetrieve;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbF.sgm new file mode 100644 index 00000000..64fca59f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbF.sgm @@ -0,0 +1,147 @@ + + + + + + + + + + + +XmClipboardInquireCount +library call + + +XmClipboardInquireCount +A clipboard function that returns the number of data item formats + +XmClipboardInquireCount + +clipboard functions +XmClipboardInquireCount + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardInquireCount (display, window, count, + max_format_name_length) + Display * display; + Window window; + int * count; + unsigned long * max_format_name_length; + + + + + + +DESCRIPTION +XmClipboardInquireCount returns the number of data item formats available +for the data item in the clipboard. This function also returns the +maximum name-length for all formats in which the data item is +stored. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +count + +Returns the number of data item formats available for the data item in +the clipboard. If no formats are available, this argument equals 0 +(zero). The count includes the formats that were passed by name. + + + + +max_format_name_length + +Specifies the maximum length of all format names for the data item in +the clipboard. + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardNoData + +The function could not find data on the clipboard corresponding to the +format requested. This could occur because the clipboard is empty; +there is data on the clipboard, but not in the requested format; or +the data in the requested format was passed by name and is no longer +available. + + + + + + +RELATED +&cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbG.sgm new file mode 100644 index 00000000..d00ed8d9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbG.sgm @@ -0,0 +1,173 @@ + + + + + + + + + + + +XmClipboardInquireFormat +library call + + +XmClipboardInquireFormat +A clipboard function that returns a specified format name + +XmClipboardInquireFormat + +clipboard functions +XmClipboardInquireFormat + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardInquireFormat (display, window, index, format_name_buf, + buffer_len, copied_len) + Display * display; + Window window; + int index; + XtPointer format_name_buf; + unsigned long buffer_len; + unsigned long * copied_len; + + + + + + +DESCRIPTION +XmClipboardInquireFormat returns a specified format name for the +data item in the clipboard. If the name must be truncated, the +function returns a warning status. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +index + +Specifies which of the ordered format names to obtain. If this index +is greater than the number of formats for the data item, +this function returns a 0 (zero) in the copied_len argument. + + + + +format_name_buf + +Specifies the buffer that receives the format name. + + + + +buffer_len + +Specifies the number of bytes in the format name buffer. + + + + +copied_len + +Specifies the number of bytes in the +data item copied to the buffer. +If this +argument equals 0 (zero), there is no nth format for the data item. + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardTruncate + +The data returned is truncated because the user did not provide a buffer +large enough to hold the data. + + + + +XmClipboardNoData + +The function could not find data on the clipboard corresponding to the +format requested. +This could occur because the clipboard is empty; there is data +on the clipboard, but not in the requested format; or the data in +the requested format was passed by name and is no longer available. + + + + + + +RELATED +&cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbH.sgm new file mode 100644 index 00000000..cec972e7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbH.sgm @@ -0,0 +1,152 @@ + + + + + + + + + + + +XmClipboardInquireLength +library call + + +XmClipboardInquireLength +A clipboard function that returns the length of the stored data + +XmClipboardInquireLength + +clipboard functions +XmClipboardInquireLength + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardInquireLength (display, window, format_name, length) + Display * display; + Window window; + char * format_name; + unsigned long * length; + + + + + + +DESCRIPTION +XmClipboardInquireLength returns the length of the data stored +under a specified format name for the clipboard data item. If no data +is found for the specified format, or if there is no item on the +clipboard, this function returns a value of 0 +(zero) in the length argument. + +Any format passed by name is assumed to have length passed in +a call to XmClipboardCopy, even though the data has not yet been +transferred to the clipboard in that format. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +format_name + +Specifies the name of the format for the data item. + + + + +length + +Specifies the length of the next data item in the specified format. This +argument equals 0 (zero) if no data is found for the specified format, +or if there is no item on the clipboard. + + + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardNoData + +The function could not find data on the clipboard corresponding to the +format requested. This could occur because the clipboard is empty; +there is data on the clipboard, but not in the requested format; or +the data in the requested format was passed by name and is no longer +available. + + + + + + +RELATED +&cdeman.XmClipboardCopy; and &cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbI.sgm new file mode 100644 index 00000000..3a8ff34f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbI.sgm @@ -0,0 +1,155 @@ + + + + + + + + + + + +XmClipboardInquirePendingItems +library call + + +XmClipboardInquirePendingItems +A clipboard function that returns a list of data ID/private ID pairs + +XmClipboardInquirePending\\%Items + +clipboard functions +XmClipboardInquirePending\\%Items + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardInquirePendingItems (display, window, format_name, item_list, count) + Display * display; + Window window; + char * format_name; + XmClipboardPendingList * item_list; + unsigned long * count; + + + + + + +DESCRIPTION +XmClipboardInquirePendingItems returns a list of +data ID/private ID pairs +for the specified format name. A data item is considered pending if the +application originally passed it by name, the application has not yet +copied the data, and the item has not been deleted from the clipboard. +The application is responsible for freeing the memory provided by this +function to store the list. +To free the memory, call XtFree. + +This function is used by an application when exiting, to determine if the +data that is passed by name should be sent to the clipboard. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +format_name + +Specifies a string that contains the name of the format for which the list +of data ID/private ID pairs is to be obtained. + + + + +item_list + +Specifies the address of the array of data ID/private ID pairs for the +specified format name. This argument is a type +XmClipboardPendingList. +The application is +responsible for freeing the memory provided by this function +for storing the list. + + + + +count + +Specifies the number of items returned in the list. If there is no data for +the specified format name, or if there is no item on the clipboard, this +argument equals 0 (zero). + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbJ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbJ.sgm new file mode 100644 index 00000000..519fa6d5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbJ.sgm @@ -0,0 +1,127 @@ + + + + + + + + + + + +XmClipboardLock +library call + + +XmClipboardLock +A clipboard function that locks the clipboard + +XmClipboardLock + +clipboard functions +XmClipboardLock + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardLock (display, window) + Display * display; + Window window; + + + + + + +DESCRIPTION +XmClipboardLock locks the clipboard from access by another +application until XmClipboardUnlock is called. All clipboard +functions lock and unlock the clipboard to prevent simultaneous +access. This function allows the application to keep the clipboard +data from changing between calls to Inquire and +other clipboard functions. The application does not need to +lock the clipboard between calls to XmClipboardStartCopy and +XmClipboardEndCopy or to XmClipboardStartRetrieve and +XmClipboardEndRetrieve. + +If the clipboard is already locked by another application, +XmClipboardLock returns an error status. Multiple calls to this +function by the same application increase the lock level. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardEndCopy;, &cdeman.XmClipboardEndRetrieve;, +&cdeman.XmClipboardStartCopy;, &cdeman.XmClipboardStartRetrieve;, and +&cdeman.XmClipboardUnlock;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbK.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbK.sgm new file mode 100644 index 00000000..ba96a4ee --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbK.sgm @@ -0,0 +1,146 @@ + + + + + + + + + + + +XmClipboardRegisterFormat +library call + + +XmClipboardRegisterFormat +A clipboard function that registers a new format + +XmClipboardRegisterFormat + +clipboard functions +XmClipboardRegisterFormat + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardRegisterFormat (display, format_name, format_length) + Display * display; + char * format_name; + int format_length; + + + + + + +DESCRIPTION +XmClipboardRegisterFormat registers a new format. Each format +stored on the clipboard should have a length associated with it; this +length must be known to the clipboard routines. Formats are known as +targets in the Inter-Client Communication Conventions Manual +(ICCCM). All of the formats specified by +version 1.1 of the ICCCM +conventions are preregistered. Any other format that the application +wants to use must either be 8-bit +data or be registered via this routine. +Failure to +register the length of the data results in incompatible applications across +platforms having different byte-swapping orders. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +format_name + +Specifies the string name for the new format (target). + + + + +format_length + +Specifies the format length in bits (8, 16, or 32). + + + + + + +RETURN + + +XmClipboardBadFormat + +The format_name must not be NULL, and the format_length +must be 8, 16, or 32. + + + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardFail + +The function failed because the specified format was already registered with a +different length from that specified now. If a specified format was already +registered with the same +length as that specified now, XmClipboardSuccess is returned. + + + + + + +RELATED +&cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbL.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbL.sgm new file mode 100644 index 00000000..93fb68bb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbL.sgm @@ -0,0 +1,203 @@ + + + + + + + + + + + +XmClipboardRetrieve +library call + + +XmClipboardRetrieve +A clipboard function that retrieves a data item from the clipboard + +XmClipboardRetrieve + +clipboard functions +XmClipboardRetrieve + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardRetrieve (display, window, format_name, + buffer, length, num_bytes, private_id) + Display * display; + Window window; + char * format_name; + XtPointer buffer; + unsigned long length; + unsigned long * num_bytes; + long * private_id; + + + + + + +DESCRIPTION +XmClipboardRetrieve retrieves the current data item from clipboard +storage. It returns a warning if the clipboard is locked, if there is +no data on the clipboard, or if the data needs to be truncated because the +buffer length is too short. + +Between a call +to XmClipboardStartRetrieve and a call to XmClipboardEndRetrieve, +multiple calls to XmClipboardRetrieve +with the same format name result +in data being incrementally copied from the clipboard until the data in that +format has all been copied. + +The return value XmClipboardTruncate from calls to +XmClipboardRetrieve indicates that more data remains to be copied in the +given format. +It is recommended that any calls to the Inquire functions that +the application needs to make to effect the copy from the clipboard be +made between the call to XmClipboardStartRetrieve and the first +call to XmClipboardRetrieve. This way, the application does not +need to call XmClipboardLock and XmClipboardUnlock. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +format_name + +Specifies the name of a format in which the data +is stored on the clipboard. + + + + +buffer + +Specifies the buffer to which the application wants the +clipboard to copy the data. +The function allocates space to hold the data returned into the buffer. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XtFree. + + + + +length + +Specifies the length of the application buffer. + + + + +num_bytes + +Specifies the number of bytes of data copied into the application +buffer. + + + + +private_id + +Specifies the private data stored with the data item by the +application that placed the data item on the clipboard. If the +application did not store private data with the data item, this +argument returns 0 (zero). + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + +XmClipboardTruncate + +The data returned is truncated because the user did not provide a buffer +large enough to hold the data. + + + + +XmClipboardNoData + +The function could not find data on the clipboard corresponding to the +format requested. This could occur because the clipboard is empty; +there is data on the clipboard but not in the requested format; or the +data in the requested format was passed by name and is no longer +available. + + + + + + +RELATED +&cdeman.XmClipboardEndRetrieve;, &cdeman.XmClipboardLock;, +&cdeman.XmClipboardStartCopy;, &cdeman.XmClipboardStartRetrieve;, +and &cdeman.XmClipboardUnlock;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbM.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbM.sgm new file mode 100644 index 00000000..d3d1d7a5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbM.sgm @@ -0,0 +1,252 @@ + + + + + + + + + + + +XmClipboardStartCopy +library call + + +XmClipboardStartCopy +A clipboard function that sets up a storage and data structure + +XmClipboardStartCopy + +clipboard functions +XmClipboardStartCopy + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardStartCopy (display, window, clip_label, + timestamp, widget, callback, item_id) + Display * display; + Window window; + XmString clip_label; + Time timestamp; + Widget widget; + XmCutPasteProc callback; + long * item_id; + + + + + + +DESCRIPTION +XmClipboardStartCopy +sets up storage and data structures to receive clipboard data. +An application calls this function during a cut or copy operation. +The data item that these structures receive then becomes +the next data item in the clipboard. + +Copying a large piece of data to the clipboard can take a long time. +It is possible that, once the data is copied, no application will ever +request that data. The Motif Toolkit provides a mechanism so that an +application does not need to actually pass data to the clipboard until +the data has been requested by some application. + +Instead, the application passes format and length information in +XmClipboardCopy to the clipboard functions, along with a widget +ID and a callback function address that is passed in +XmClipboardStartCopy. The widget ID is necessary for +communications between the clipboard functions in the application that +owns the data and the clipboard functions in the application that +requests the data. + +The callback functions are responsible for copying the actual data to +the clipboard through XmClipboardCopyByName. The callback +function is also called if the data item is removed from the clipboard +and the actual data is no longer needed. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +clip_label + +Specifies the label to be associated with the data item. +This argument +is used to identify the data item, as in a clipboard viewer. +An example of a label is the name of the application that places the +data in the clipboard. + + + + +timestamp + +Specifies the time of the event that triggered the copy. +A valid timestamp must be supplied; it is not sufficient to use +CurrentTime. + + + + +widget + +Specifies the ID of the widget that receives messages requesting data +previously passed by name. This argument must be present in order to +pass data by name. Any valid widget ID in your application can be +used for this purpose and all the message handling is taken care of by +the cut and paste functions. + + + + +callback + +Specifies the address of the callback function that is called when the +clipboard needs data that was originally passed by name. This is also +the callback to receive the delete message for items that were +originally passed by name. This argument must be present in order to +pass data by name. + + + + +item_id + +Specifies the number assigned to this data item. +The application uses this number in calls to +XmClipboardCopy, XmClipboardEndCopy, and +XmClipboardCancelCopy. + + + + +For more information on passing data by name, see +&cdeman.XmClipboardCopy; and &cdeman.XmClipboardCopyByName;. + +The widget and callback arguments must be present in order to +pass data by name. The callback format is as follows: + + +void (*callback) (widget, data_id, private, reason) + Widget widget; + long *data_id; + long *private; + int *reason; + + + + + + +widget + +Specifies the ID of the widget passed to this function. + + + + +data_id + +Specifies the identifying number returned by +XmClipboardCopy, which identifies the pass-by-name data. + + + + +private + +Specifies the private information passed to +XmClipboardCopy. + + + + +reason + +Specifies the reason. XmCR_CLIPBOARD_DATA_DELETE +or XmCR_CLIPBOARD_DATA_REQUEST +are the possible values. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardCancelCopy;, &cdeman.XmClipboardCopy;, +&cdeman.XmClipboardCopyByName;, +&cdeman.XmClipboardEndCopy;, &cdeman.XmClipboardEndRetrieve;, +&cdeman.XmClipboardInquireCount;, &cdeman.XmClipboardInquireFormat;, +&cdeman.XmClipboardInquireLength;, &cdeman.XmClipboardInquirePendingItems;, +&cdeman.XmClipboardLock;, &cdeman.XmClipboardRegisterFormat;, +&cdeman.XmClipboardRetrieve;, +&cdeman.XmClipboardStartRetrieve;, &cdeman.XmClipboardUndoCopy;, +&cdeman.XmClipboardUnlock;, and &cdeman.XmClipboardWithdrawFormat;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbN.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbN.sgm new file mode 100644 index 00000000..96842300 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbN.sgm @@ -0,0 +1,148 @@ + + + + + + + + + + + +XmClipboardStartRetrieve +library call + + +XmClipboardStartRetrieve +A clipboard function that prepares +to retrieve data from the clipboard + +XmClipboardStartRetrieve + +clipboard functions +XmClipboardStartRetrieve + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardStartRetrieve (display, window, timestamp) + Display * display; + Window window; + Time timestamp; + + + + + + +DESCRIPTION +XmClipboardStartRetrieve +tells the clipboard routines that the application is +ready to start copying an item from the clipboard. +The clipboard is locked by this routine and stays locked until +XmClipboardEndRetrieve is called. Between a call to +XmClipboardStartRetrieve and a call to +XmClipboardEndRetrieve, multiple calls to +XmClipboardRetrieve with the same format name result in data +being incrementally copied from the clipboard until the data in that +format has all been retrieved. + +A return value of XmClipboardTruncate from calls to +XmClipboardRetrieve indicates that more data remains to be +copied in the given format. +It is recommended that any calls to the Inquire functions that +the application needs to make to complete the copy from the clipboard +be made between the call to XmClipboardStartRetrieve and the +first call to XmClipboardRetrieve. This way, the application +does not need to call XmClipboardLock and +XmClipboardUnlock. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +timestamp + +Specifies the time of the event that triggered the copy. +A valid timestamp must be supplied; it is not sufficient to use +CurrentTime. + + + + + + +RETURN + + +XmClipboardSuccess + +The function is successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardEndRetrieve;, +&cdeman.XmClipboardInquireCount;, &cdeman.XmClipboardInquireFormat;, +&cdeman.XmClipboardInquireLength;, &cdeman.XmClipboardInquirePendingItems;, +&cdeman.XmClipboardLock;, +&cdeman.XmClipboardRetrieve;, &cdeman.XmClipboardStartCopy;, and +&cdeman.XmClipboardUnlock;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbO.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbO.sgm new file mode 100644 index 00000000..3aa9c29f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbO.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmClipboardUndoCopy +library call + + +XmClipboardUndoCopy +A clipboard function that deletes the last item placed on the clipboard + +XmClipboardUndoCopy + +clipboard functions +XmClipboardUndoCopy + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardUndoCopy (display, window) + Display * display; + Window window; + + + + + + +DESCRIPTION +XmClipboardUndoCopy +deletes the last item placed on the clipboard if the item +was placed there by an application with the passed display and +window arguments. Any data item deleted from the clipboard by the +original call to XmClipboardCopy is restored. If the display +or window IDs do not match the last copied item, no action is taken, +and this function has no effect. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each +clipboard function it calls. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardLock; and &cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbP.sgm new file mode 100644 index 00000000..6033a41f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbP.sgm @@ -0,0 +1,131 @@ + + + + + + + + + + + +XmClipboardUnlock +library call + + +XmClipboardUnlock +A clipboard function that unlocks the clipboard + +XmClipboardUnlock + +clipboard functions +XmClipboardUnlock + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardUnlock (display, window, remove_all_locks) + Display * display; + Window window; + Boolean remove_all_locks; + + + + + + +DESCRIPTION +XmClipboardUnlock unlocks the clipboard, +enabling it to be accessed by other applications. + +If multiple calls to XmClipboardLock have occurred, the same +number of calls to XmClipboardUnlock is necessary to unlock the +clipboard, unless remove_all_locks is set to True. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that relates the application window to the +clipboard. The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each of the +clipboard functions that it calls. + + + + +remove_all_locks + +When True, indicates that all nested locks should be removed. When False, +indicates that only one level of lock should be removed. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardFail + +The function failed because the clipboard was not locked or was locked +by another application. + + + + + + +RELATED +&cdeman.XmClipboardCancelCopy;, &cdeman.XmClipboardCopy;, +&cdeman.XmClipboardEndCopy;, &cdeman.XmClipboardEndRetrieve;, +&cdeman.XmClipboardInquireCount;, &cdeman.XmClipboardInquireFormat;, +&cdeman.XmClipboardInquireLength;, &cdeman.XmClipboardInquirePendingItems;, +&cdeman.XmClipboardLock;, &cdeman.XmClipboardRegisterFormat;, +&cdeman.XmClipboardRetrieve;, &cdeman.XmClipboardStartCopy;, +&cdeman.XmClipboardStartRetrieve;, &cdeman.XmClipboardUndoCopy;, +and &cdeman.XmClipboardWithdrawFormat;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbQ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbQ.sgm new file mode 100644 index 00000000..18466e8a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ClipbQ.sgm @@ -0,0 +1,126 @@ + + + + + + + + + + + +XmClipboardWithdrawFormat +library call + + +XmClipboardWithdrawFormat +A clipboard function that indicates that the application no longer wants to supply a data item + +XmClipboardWithdrawFormat + +clipboard functions +XmClipboardWithdrawFormat + + + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CutPaste.h> +int XmClipboardWithdrawFormat (display, window, data_id) + Display * display; + Window window; + long data_id; + + + + + + +DESCRIPTION +XmClipboardWithdrawFormat indicates that the application no longer +supplies a data item to the clipboard that the application had +previously passed by name. + + + +display + +Specifies a pointer to the Display structure that was returned in a +previous call to XOpenDisplay or XtDisplay. + + + + +window + +Specifies the window ID of a widget that +relates the application window to the clipboard. +The widget's window ID can be obtained through +XtWindow. +The same application instance should pass the same window ID to each +clipboard function it calls. + + + + +data_id + +Specifies an identifying number assigned to the data item, that +uniquely identifies the data item and the format. This was assigned +to the item when it was originally passed by XmClipboardCopy. + + + + + + +RETURN + + +XmClipboardSuccess + +The function was successful. + + + + +XmClipboardLocked + +The function failed because the clipboard was locked by another +application. The application can continue to call the function again with +the same parameters until the lock goes away. This gives the application +the opportunity to ask if the user wants to keep trying or to give up +on the operation. + + + + + + +RELATED +&cdeman.XmClipboardCopy; and &cdeman.XmClipboardStartCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboAdd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboAdd.sgm new file mode 100644 index 00000000..2715fb72 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboAdd.sgm @@ -0,0 +1,69 @@ + + + + + + + + + + +XmComboBoxAddItem +library call + + +XmComboBoxAddItem +add an item to the ComboBox widget + + + + +#include <Xm/ComboBox.h> + +void XmComboBoxAddItem +Widget w +XmString item +int pos +Boolean unique + + + +DESCRIPTION +The +XmComboBoxAddItem function adds the given item to the XmComboBox at the given position. + +The +w argument specifies the XmComboBox widget ID. + +The +item argument specifies the +XmString for the new item. + +The +pos argument specifies the position of the new item. + +The +unique argument specifies if this item should duplicate an identical item or not. + + + +RETURN VALUE +The +XmComboBoxAddItem function returns no value. + + + +APPLICATION USAGE +The functions +XmComboBoxAddItem and +XmComboBoxDeletePos have different naming conventions (Item versus Pos) +because of the objects they are manipulating. +The Item is a string to be added, +the Pos is a numeric position number. + + + +SEE ALSO +&cdeman.XmComboBoxDeletePos;, &cdeman.XmComboBoxSetItem;, &cdeman.XmComboBoxSelectItem;. + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBU.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBU.sgm new file mode 100644 index 00000000..df519e8c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBU.sgm @@ -0,0 +1,61 @@ + + + + + + + + + + + +XmComboBoxUpdate +library call + + +XmComboBoxUpdate +A ComboBox function that resynchronizes data + + + + + + + + + + + +#include <Xm/ComboBox.h> + +void XmComboBoxUpdate + +Widget widget + + + +DESCRIPTION +XmComboBoxUpdate resynchronizes the internal data structures of a +specified ComboBox widget. This function is useful when an +application manipulates ComboBox's child widgets, possibly changing +data structures. For example, you might want to use the +XmComboBoxUpdate function after a ComboBox List child selection +has been changed without notification. + + + +widget + +Specifies the ComboBox widget ID. + + + + + + +RELATED INFORMATION +&cdeman.XmComboBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBox.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBox.sgm new file mode 100644 index 00000000..479c646f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboBox.sgm @@ -0,0 +1,1411 @@ + + + + + + + + + + +XmComboBox +library call + + +XmComboBox +The ComboBox widget class + +XmComboBox + +widget class +ComboBox + + + +#include <Xm/ComboBox.h> + + + +DESCRIPTION +XmComboBox combines the capabilities of a single-line +TextField widget +and a List widget. It allows users to perform opoerations like +typing and pasting information, and it also +provides a list of possible choices that the user +can select from to complete +the TextField entry field. The list can either be displayed at all +times or can be dropped down by the user. When the list portion of the +ComboBox is hidden, users are given a visual cue (a +downward-pointing arrow) +next to the TextField field. The position of the arrow relative to the +TextField field depends on the XmNlayoutDirection resource of the +widget. This +version of the +ComboBox is called +the "drop-down" ComboBox. Drop-down ComboBoxes are useful +when screen space is limited, or when users will +complete the text entry field more often by typing text than by +selecting the entry field text from the list. +The user can access the drop-down ComboBox in either one of two ways: + + + +By clicking and releasing Btn1 on the downward-pointing arrow, +which +pops the list up, and the list stays up. A later selection of an item +in the list will cause the item to appear in the text entry field, and +the list will unpost itself. + + + +By pressing Btn1 on the downward-pointing arrow, dragging +it to a list item, and then releasing it there, which selects that +item. The list +disappears, and the selected item appears in the text entry field. + + + +The application provides an array of strings that fill the list. At +creation time, string items can be passed to the ComboBox via an +arglist. +Each string becomes an item in the list, with the first string becoming +the item in position 1, the second string becoming the item in position 2, +and so on. The size of the list is +set by specifying the number of items that are visible in the list +(XmNvisibleItemCount). If the number of items in the list exceeds the +number of items that are visible, a vertical scroll bar will +automatically appear that allows the user to scroll through a +large number of items. + +ComboBox creates two child widgets: a TextField widget for entering +text and a ScrolledWindow containing a List for the list of items. +The name of the items list itself is List, and the name of the +TextField is Text. +The application or user can specify resource values for these widgets in +a resource file, and the application can use XtNameToWidget +(specifying "*List" for the items list or "*Text" for the +TextField widget) to obtain the widget IDs of the +descendant widgets. +At creation time, ComboBox passes appropriate resource values in the +creation arglist, including XmNitems, to the items list. +Note that the result of providing the XmNdestroyCallback +resource in the creation arglist is unspecified. The +application should use the XtAddCallback function to add +callbacks to the appropriate widget (TextField or List) after +creating it. + +ComboBox forces the following resource values +on its List child: + + + +If XmNcomboBoxType is XmCOMBO_BOX, +XmNtraversalOn is forced to False. + + + +XmNhighlightThickness is forced to 2 in a drop-down ComboBox and +to 0 in other types of ComboBoxes. + + + +XmNborderWidth is forced to 0. + + + +XmNnavigationType is forced to XmNONE. + + + +XmNselectionPolicy is forced to XmBROWSE_SELECT. + + + +XmNlistSizePolicy is forced to XmVARIABLE. + + + +XmNspacing is forced to 0. + + + +XmNvisualPolicy is forced to XmVARIABLE. + + + +XmNselectedPositions is forced to NULL. + + + +XmNselectedPositionsCount is forced to 0. + + + +When XmNcomboBoxType is XmDROP_DOWN_LIST, +ComboBox forces the following resource values on +its TextField child: + + + +XmNeditable is forced to False. + + + +XmNcursorPositionVisible is forced to False. + + + +XmNshadowThickness is forced to 0. + + + +By contrast, when XmNcomboBoxType is XmCOMBO_BOX or +XmDROP_DOWN_COMBO_BOX, ComboBox forces the following +resource values on its TextField child: + + + +XmNeditable is forced to True. + + + +XmNcursorPositionVisible is forced to True. + + + +XmNeditMode is forced to XmSINGLE_LINE_EDIT. + + + +ComboBox always forces the values of the following resources on +the TextField: + + + +XmNnavigationType is forced to XmNONE. + + + +XmNhighlightThickness is forced to 0. + + + +XmNborderWidth is forced to 0. + + + +ComboBox allows a single item to be selected in two ways: by +selecting the desired item from the List or by entering text +into the TextField. +ComboBox does not automatically select a list item if the user types +that string into the TextField. It selects the item when the user +presses KActivate or moves the focus. +ComboBox supports the Browse +Select selection model of List (see the XmList reference page +for a description of this model), so selections are mutually +exclusive. Selecting an item from the list causes +that item to be displayed in the TextField portion of the +ComboBox. +If an application sets the XmNvalue resource of TextField, +that string is shown in the TextField. +If the application has not provided any list items, +or if there is no current selection, the TextField +is empty. + +The TextField in the ComboBox widget +can be either editable or noneditable, depending on the value of +the XmNcomboBoxType resource. + +If the TextField is editable, the user can type into it. +When the user presses the Return key, the ComboBox will +compare the typed entry to the items in the List. +If there is an exact match, then the matched List item is +selected. +If the application wishes to validate the entered text (for example, to +ensure that the typed selection is a valid one), it can do so by +setting XmNmodifyVerifyCallback on the TextField widget. + +If the TextField is noneditable, typing text may invoke a matching +algorithm that will attempt to match the entered text with items in +the list. The specific matching algorithm applied, which may be none, +is determined by the value of the XmNmatchBehavior resource in +ComboBox, which can be either XmNONE or +XmQUICK_NAVIGATE. A value +of XmNONE indicates that no matching algorithm will occur. A value of +XmQUICK_NAVIGATE indicates that when the List widget has focus, +one-character navigation is supported. In this algorithm, if the typed +character is the initial character of some item in the List, this +algorithm causes that item to be navigated to and selected, and the +item is displayed in the TextField. Subsequently typing the same +character will cycle among the items with the same first character. + +Regardless of the selection mechanism used (either selected directly +from the List or typed into the TextField), when an item in the +List is selected, that item is highlighted in the List. +In addition, the selected item is displayed in the +TextField of the ComboBox. If the user performs an action +that would move focus away from ComboBox, or selects a List item, +the XmNselectionCallback callbacks are invoked to notify +the application of the current contents of the TextField (or choice). The +application then takes whatever action is required based on those +contents (or choice). + +ComboBox uses the XmQTspecifyRenderTable trait and holds the +XmQTaccessTextual trait. + + +Classes +XmComboBox inherits behavior, resources, and traits from Core, +Composite, +and XmManager classes. + +The class pointer is xmComboBoxWidgetClass. + +The class name is XmComboBox. + + + +New Resources +The following table defines a set of widget resources used by +the programmer to specify data. The programmer can also set the +resource values for the inherited classes to set attributes for +this widget. To reference a resource by name or by class in +a .Xdefaults file, remove the XmN or XmC prefix and +use the +remaining letters. To specify one of the defined values for a +resource in a .Xdefaults file, remove the Xm prefix and use the +remaining letters (in either lowercase or uppercase, but +include any underscores between words). The codes in the +access column indicate if the given resource can be at +creation time (C), set by using XtSetValues (S), retrieved by +using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + +XmComboBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNarrowSize +XmCArrowSize +Dimension +dynamic +CSG + + +XmNarrowSpacing +XmCArrowSpacing +Dimension +dynamic +CSG + + +XmNcolumns +XmCColumn +short +dynamic +CSG + + +XmNcomboBoxType +XmCComboBoxType +unsigned char +XmCOMBO_BOX +CG + + +XmNfontList +XmCFontList +XmFontList +NULL +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNitemCount +XmCItemCount +int +dynamic +CSG + + +XmNitems +XmCItems +XmStringTable +dynamic +CSG + + +XmNlist +XmCList +Widget +dynamic +G + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmatchBehavior +XmCMatchBehavior +unsigned char +dynamic +CSG + + +XmNpositionMode +XmCPositionMode +XtEnum +XmZERO_BASED +CG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNselectedItem +XmCSelectedItem +XmString +NULL +CSG + + +XmNselectedPosition +XmCSelectedPosition +int +dynamic +CSG + + +XmNselectionCallback +XmCCallback +XmCallbackList +NULL +C + + +XmtextField +XmCTextField +Widget +dynamic +G + + +XmNvisibleItemCount +XmCVisibleItemCount +int +10 +CSG + + + + + + +XmNarrowSize + +Specifies the width of the arrow. The default size +depends on the size of the text, as well as +the size of the ComboBox. + + + + +XmNarrowSpacing + +Specifies the space between the text and arrow visual in pixels. The +default value is obtained from the XmNmarginWidth resource. + + + + +XmNcolumns + +Specifies the number of columns in the text field. If unset, +the text field's value is used. Refer to the XmTextField man page +for more detailed information. + + + + +XmNcomboBoxType + +Specifies the type of ComboBox to be created. This can be one of +the following: + + + +XmCOMBO_BOX + +Generates a ComboBox where the list is always displayed, and the text +entry field is editable. + + + + +XmDROP_DOWN_COMBO_BOX + +Generates a ComboBox where the list is hidden unless specifically +requested, and the text entry field is editable. + + + + +XmDROP_DOWN_LIST + +Generates a ComboBox where the list is hidden unless specifically +requested, and the text entry field is noneditable. + + + + + + + +XmNfontList + +Specifies the fontlist associated with XmComboBox. The fontlist +is an obsolete construct, and has been superseded by the render table. +It is included for compatibility with earlier versions of Motif, and +for applications that do not easily support render tables. The +default fontlist is derived from the default render table, and if +both a fontlist and a render table are specified, the render table +takes precedence. + + + + +XmNhighlightThickness + +Specifies the thickness of the highlighting rectangle. + + + + +XmNitemCount + +Specifies the number of items in the list. If unset, +the lists's value is used. +Refer to the XmList man page for more detailed information. + + + + +XmNitems + +Specifies the items in the list. If unset, +the lists's value is used. Refer to the XmList man page for more detailed information. + + + + +XmNlist + +The list widget. + + + + +XmNmarginWidth + +Specifies the horizontal spacing between the child widgets and the boundary +of the ComboBox. + + + + +XmNmarginHeight + +Specifies the vertical spacing between the child widgets and the boundary +of the ComboBox. + + + + +XmNmatchBehavior + +Defines the matching algorithm applied to match the text +typed by the user in the TextField field with items in the list. +The current values are XmNONE and XmQUICK_NAVIGATE, as follows: + + + +XmNONE + +Indicates that there is no assigned matching algorithm. + + + + +XmQUICK_NAVIGATE + +Is only valid for noneditable ComboBoxes (XmNcomboBoxType resource value +XmDROP_DOWN_LIST). This algorithm supports 1-character navigation +when the List widget has focus. If the typed character is the +initial character of some item in the List, this algorithm causes +that item to be navigated to and selected. Subsequently typing the +same character will cycle among the items with the same first character. + + + + + + + +XmNpositionMode + +Specifies how the value of the +XmNselectedPosition +resource and the item_position field +of the callback structure are to be interpreted. Note that +the convenience functions XmComboBoxDeletePos and XmComboBoxAddItem +are not affected by this resource, and (like XmList) always use +1-based positions. Valid values for this resource are: + + + +XmZERO_BASED + +(DtComboBox compatibility mode: default) XmNselectedPosition +is in [0,itemcount-1]. +The item_position in the XmComboBoxCallbackStruct +is 0 if the first element in the list +was selected. Note that 0 is also returned if no element in the list +was selected (that is, a new item was entered in the text field). + + + + +XmONE_BASED + +(Motif mode) Both the resource value and the callback fields +are 1-based. This is consistent with other Motif widgets. + + + + + + + +XmNrenderTable + +Specifies the render table associated with ComboBox. +This render table is used in both the TextField field and the +List in the ComboBox. This is used in conjunction with the +XmNvisibleItemCount resource of the List to determine the height +of the ComboBox widget. + +If this value is NULL at initialization, and if the widget parent is +XmBulletinBoard or its subclasses, +VendorShell or its subclasses, or XmMenuShell, then the +widget parent provides the default render table associated with +the widget. +If both a render table and a fontlist are specified, the render table +will take precedence. + + + + +XmNselectedItem + +Specifies a compound string that represents the current selection of +the ComboBox. The selected item is the content of the +ComboBox text entry field. + + + + +XmNselectedPosition + +If the selection in the ComboBox is an item in the list, this is +the index of the selected item in the list. If no item in +the list is selected, this is 0. + + + + +XmNselectionCallback + +Specifies the list of callbacks called when an item is selected. +The reason field in the XmComboBoxCallbackStruct is +XmCR_SELECT. + + + + +XmNtextField + +The text field widget. + + + + +XmNvisibleItemCount + +Specifies the number of visible items in the list. This will override any +value specified for the list. +Refer to the XmList man page for more detailed information. + + + + + + +Inherited Resources +ComboBox inherits behavior and resources from superclasses described +in the following tables. For a complete description of each +resource, refer to the reference page for that superclass. + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmSTICKY_TAG_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback. +The callback structure is defined as follows: + +typedef struct +{ + int reason; + XEvent *event; + XmString item_or_text; + int item_position; +} XmComboBoxCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +item_or_text + +The contents of the text field at the time the event caused the +callback. The item_or_text parameter points to a temporary +storage space that is +reused after the callback is finished. If an application needs to save +the item, it should copy item_or_text into its own data space. + + + + +item_position + +The position of item in the list's XmNitems 1-based array. If this +is 0, it means that the item_or_text was not selected from the +List. + + + + + + +Translations +The ComboBox translations are listed below. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +The KPageUp and KPageDown translations do not take effect unless the +List child widget is posted. + + + + +Btn1Down: + +CBArmAndDropDownList() + + + + +Btn1Up: + +CBDisarm() + + + + + +The following lists the List translations in the drop-down list. When +ComboBox XmNcomboBoxType is +XmDROP_DOWN_LIST, +osfActivate, osfCancel, and +Return are overriden by ComboBox actions. + + + +:c <Key>osfDown: + +CBDropDownList() + + + + +:c <Key>osfUp: + +CBDropDownList() + + + + +:<Key>osfCancel: + +CBCancel() + + + + +:<Key>osfActivate: + +CBActivate() + + + + +≈s ≈m ≈a<Key>Return: + +CBActivate() + + + + + + + +Accelerators +The following accelerators are added to ComboBox and its children. +The accelerators may not directly correspond to a translation table. +If the translation is not listed below, it may depend on the context +of the event. + + + +:c <Key>osfUp: + +CBDropDownList() + + + + +:<Key>osfUp: + +CBListAction(Up) + + + + +:c <Key>osfDown: + +CBDropDownList() + + + + +:<Key>osfDown: + +CBListAction(Down) + + + + +:c <Key>osfBeginLine: + +CBListAction(ListBeginData) + + + + +:c <Key>osfEndLine: + +CBListAction(ListEndData) + + + + +:<Key>osfPageUp: + +CBListAction(ListPrevPage) + + + + +:<Key>osfPageDown: + +CBListAction(ListNextPage) + + + + + +A drop-down ComboBox also adds accelerators to its List child. +Aside from the accelerators that are already listed in this section, +those accelerators are the default TextField key translations. + + + +Action Routines +The XmComboBox action routines are as follows: + + + +CBActivate(): + +Calls the XmNselectionCallback callbacks. If the +XmNcomboBoxType is +XmDROP_DOWN_COMBO_BOX or XmDROP_DOWN_LIST, it unposts the +list. If the +parent is a manager, passes the event to the parent. + + + + +CBArmAndDropDownList(): + +If the pointer is within the down arrow, draws the shadow of the arrow +in the selected state, and then posts the list. + + + + +CBCancel(): + +If the XmNcomboBoxType is XmDROP_DOWN_COMBO_BOX or +XmDROP_DOWN_LIST, pops down +the list. If the parent is a manager, passes the event to the parent. + + + + +CBDisarm(): + +Redraws the arrow in an unselected state. + + + + +CBDropDownList(): + +If XmNcomboBoxType is XmDROP_DOWN or XmDROP_DOWN_LIST, and +list is not +displayed, posts the list. If list is displayed, it unposts the list. + + + + +CBListAction(ListBeginData): + +Moves the location cursor to the first item in the list. +In Normal Mode, this also deselects any current selection, +selects the first item in the list, and calls the +XmNbrowseSelectionCallback selection callback. + + + + +CBListAction(ListEndData): + +Moves the location cursor to the last item in the list. +In Normal Mode, this also deselects any current selection, +selects the last item in the list, and calls the +XmNbrowseSelectionCallback selection callback. + + + + +CBListAction(ListPrevPage): + +Scrolls the list to the previous page, moving the location cursor to a +new item. +This action also selects the new item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. +If the ComboBox is not a drop-down type, then this action does +nothing. + + + + +CBListAction(ListNextPage): + +Scrolls the list to the next page, moving the location cursor to a new +item. +This action also selects the new item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. +If the ComboBox is not a drop-down type, then this action does +nothing. + + + + +CBListAction(Up): + +Moves the location cursor to the previous item in the list. +This action also selects the previous item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. +Note that, unlike the List ListPrevItem action, this action wraps +around. + + + + +CBListAction(Down): + +Moves the location cursor to the next item in the list. +This action also selects the next item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. +Note that, unlike the List ListNextItem action, this action wraps +around. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. For information +about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + + +ERRORS/WARNINGS +The toolkit will display a warning if the application tries to +set the value of XmNlist +or the XmNtextField resource, which are read-only (marked G in the resource +table). + + + +RELATED +&cdeman.Composite;, +&cdeman.Core;, +&cdeman.XmCreateComboBox;, +&cdeman.XmList;, +&cdeman.XmManager;, and +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboDel.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboDel.sgm new file mode 100644 index 00000000..70be49fb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboDel.sgm @@ -0,0 +1,61 @@ + + + + + + + + + + +XmComboBoxDeletePos +library call + + +XmComboBoxDeletePos + Delete a XmComboBox item + + + + +#include <Xm/ComboBox.h> + +void XmComboBoxDeletePos +Widget w +int pos + + + +DESCRIPTION +The +XmComboBoxDeletePos function deletes a specified item from a XmComboBox widget. + +The +w argument specifies the XmComboBox widget ID. + +The +pos argument specifies the position of the item to be deleted. + + + +RETURN VALUE +The +XmComboBoxDeletePos function returns no value. + + + +APPLICATION USAGE +The functions +XmComboBoxAddItem and +XmComboBoxDeletePos have different naming conventions (Item versus Pos) +because of the objects they are manipulating. +The Item is a string to be added, +the Pos is a numeric position number. + + + +SEE ALSO +&cdeman.XmComboBoxAddItem;, &cdeman.XmComboBoxSetItem;, &cdeman.XmComboBoxSelectItem;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSel.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSel.sgm new file mode 100644 index 00000000..46e67572 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSel.sgm @@ -0,0 +1,57 @@ + + + + + + + + + + +XmComboBoxSelectItem +library call + + +XmComboBoxSelectItem +select a XmComboBox item + + + + +#include <Xm/ComboBox.h> + +void XmComboBoxSelectItem +Widget w +XmString item + + + +DESCRIPTION +The +XmComboBoxSelectItem function selects an item in the XmList of the XmComboBox +widget. + +The +w argument specifies the XmComboBox widget ID. + +The +item argument specifies the +XmString of the item to be selected. +If the +item is not found on the list, +XmComboBoxSelectItem notifies the user via the +XtWarning function. + + + +RETURN VALUE +The +XmComboBoxSelectItem function returns no value. + + + +SEE ALSO +&cdeman.XmComboBoxAddItem;, &cdeman.XmComboBoxDeletePos;, &cdeman.XmComboBoxSetItem;; XtWarning(3). ]]>XtWarning ]]>in the &str-Zt;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSet.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSet.sgm new file mode 100644 index 00000000..2e5e64e2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ComboSet.sgm @@ -0,0 +1,57 @@ + + + + + + + + + + +XmComboBoxSetItem +library call + + +XmComboBoxSetItem +set an item in the XmComboBox list + + + + +#include <Xm/ComboBox.h> + +void XmComboBoxSetItem +Widget w +XmString item + + + +DESCRIPTION +The +XmComboBoxSetItem function selects an item in the XmList of the given XmComboBox +widget and makes it the first visible item in the list. + +The +w argument specifies the XmComboBox widget ID. + +The +item argument specifies the +XmString for the item to be set in the XmComboBox. +If the +item is not found on the list, +XmComboBoxSetItem notifies the user via the +XtWarning function. + + + +RETURN VALUE +The +XmComboBoxSetItem function returns no value. + + + +SEE ALSO +&cdeman.XmComboBoxAddItem;, &cdeman.XmComboBoxDeletePos;, &cdeman.XmComboBoxSelectItem;; XtWarning(3). ]]>XtWarning ]]>in the &str-Zt;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommAp.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommAp.sgm new file mode 100644 index 00000000..389fe908 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommAp.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmCommandAppendValue +library call + + +XmCommandAppendValue +A Command function that appends the passed XmString to the end of the string displayed in the command area of the widget + +XmCommandAppendValue + +Command functions +XmCommandAppendValue + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Command.h> + +void XmCommandAppendValue + +Widget widget +XmString command + + + +DESCRIPTION +XmCommandAppendValue appends the passed XmString +to the end of the string displayed in the command +area of the Command widget. + + + +widget + +Specifies the Command widget ID + + + + +command + +Specifies the passed XmString + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommEr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommEr.sgm new file mode 100644 index 00000000..2c55ddcb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommEr.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmCommandError +library call + + +XmCommandError +A Command function that displays an error message + +XmCommandError + +Command functions +XmCommandError + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Command.h> + +void XmCommandError + +Widget widget +XmString error + + + +DESCRIPTION +XmCommandError displays an error message in the history +area of the Command widget. The XmString error is displayed until +the next command entered occurs. + + + +widget + +Specifies the Command widget ID + + + + +error + +Specifies the passed XmString + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommGe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommGe.sgm new file mode 100644 index 00000000..21aac52f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommGe.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmCommandGetChild +library call + + +XmCommandGetChild +A Command function that is used to access a component + +XmCommandGetChild + +Command functions +XmCommandGetChild + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Command.h> + +Widget XmCommandGetChild + +Widget widget +unsigned char child + + + +DESCRIPTION +XmCommandGetChild is used to access a component within a Command. The +parameters given to the function are the Command widget and a value +indicating which component to access. + + + +widget + +Specifies the Command widget ID. + + + + +child + +Specifies a component within the Command. +The following values are legal for +this parameter: + + + +XmDIALOG_COMMAND_TEXT + + + +XmDIALOG_PROMPT_LABEL + + + +XmDIALOG_HISTORY_LIST + + + +XmDIALOG_WORK_AREA + + + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RETURN +Returns the widget ID of the specified Command component. +An application should not assume that the returned widget will be of any +particular class. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommSe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommSe.sgm new file mode 100644 index 00000000..f0c05ad7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CommSe.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmCommandSetValue +library call + + +XmCommandSetValue +A Command function that replaces a displayed string + +XmCommandSetValue + +Command functions +XmCommandSetValue + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Command.h> + +void XmCommandSetValue + +Widget widget +XmString command + + + +DESCRIPTION +XmCommandSetValue replaces the string displayed in the +command area of the Command widget with the passed XmString. + + + +widget + +Specifies the Command widget ID + + + + +command + +Specifies the passed XmString + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Command.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Command.sgm new file mode 100644 index 00000000..f57fd749 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Command.sgm @@ -0,0 +1,1199 @@ + + + + + + + + + + + +XmCommand +library call + + +XmCommand +The Command widget class + +XmCommand + +widget class +Command + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Command.h> + + + +DESCRIPTION +Command is a special-purpose composite widget for command +entry that provides a built-in command-history mechanism. +Command includes a command-line text-input field, a command-line prompt, +and a command-history list region. + +One additional WorkArea child may be added to the Command after +creation. + +Whenever a command is entered, it is +automatically added to the end of the command-history list and made visible. +This does not change the selected item in the list, if there is one. + +Many of the new resources specified for Command are actually SelectionBox +resources that have been renamed for clarity and ease of use. + + +Descendants +Command automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +ItemsList +XmList +command-history list region + + +ItemsListSW +XmScrolledWindow +the ScrolledWindow parent of ItemsList + + +Selection +XmLabelGadget +command-line prompt + + +Text +XmTextField +command-line text-input field + + + + + + +Classes +Command inherits behavior, resources, and traits from Core, +Composite, Constraint, XmManager, +XmBulletinBoard, and XmSelectionBox. + +The class pointer is xmCommandWidgetClass. + +The class name is XmCommand. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. +To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmCommand Resource Set + + +Name +Class +Type +Default +Access + + +XmNcommand +XmCTextString +XmString +"" +CSG + + +XmNcommandChangedCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcommandEnteredCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhistoryItems +XmCItems +XmStringTable +NULL +CSG + + +XmNhistoryItemCount +XmCItemCount +int +0 +CSG + + +XmNhistoryMaxItems +XmCMaxItems +int +100 +CSG + + +XmNhistoryVisibleItemCount +XmCVisibleItemCount +int +dynamic +CSG + + +XmNpromptString +XmCPromptString +XmString +dynamic +CSG + + + + + + +XmNcommand + +Contains the current command-line text. This is the XmNtextString +resource in SelectionBox, renamed for Command. +This resource can also be modified with +XmCommandSetValue and XmCommandAppendValue functions. +The command area is a Text widget. + + + + +XmNcommandChangedCallback + +Specifies the list of callbacks that is called after +each time the value of the command changes. +The callback reason is XmCR_COMMAND_CHANGED. +This is equivalent to the XmNvalueChangedCallback of the Text +widget, except that a pointer to an XmCommandCallbackStructure is +passed, and the structure's value member contains the +XmString. + + + + +XmNcommandEnteredCallback + +Specifies the list of callbacks that is called +when a command is entered in the Command. +The callback reason is XmCR_COMMAND_ENTERED. A pointer to an +XmCommandCallback structure is passed. + + + + +XmNhistoryItems + +Lists XmString items that make up the contents +of the history list. This is the XmNlistItems resource in +SelectionBox, renamed for Command. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items. + + + + +XmNhistoryItemCount + +Specifies the number of XmStrings in XmNhistoryItems. This is +the XmNlistItemCount resource in SelectionBox, renamed for Command. +The value must not be negative. + + + + +XmNhistoryMaxItems + +Specifies the maximum number of items allowed in the history list. Once +this number is reached, an existing list item must be removed before +a new item can be added to the list. For each command entered, the first list +item is removed from the list, so the new command can be added to the list. +The value must be greater than 0 (zero). + + + + +XmNhistoryVisibleItemCount + +Specifies the number of items in the history list that should be visible at +one time. In effect, it sets the height (in lines) of the history list +window. This is the XmNlistVisibleItemCount resource in SelectionBox, +renamed for Command. +The value must be greater than 0 (zero). +The default is dynamic based on the height of the list. + + + + +XmNpromptString + +Specifies a prompt for the command line. +This is the XmNselectionLabelString +resource in SelectionBox, renamed for Command. +The default may vary depending on the value of the +XmNlayoutDirection +resource and the locale. +In the C locale the default is > (right angle bracket). + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + + + +Inherited Resources +Command inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmSelectionBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNapplyCallback +XmCCallback +XtCallbackList +NULL +N/A + + +XmNapplyLabelString +XmCApplyLabelString +XmString +dynamic +N/A + + +XmNcancelCallback +XmCCallback +XtCallbackList +NULL +N/A + + +XmNcancelLabelString +XmCCancelLabelString +XmString +dynamic +N/A + + +XmNchildPlacement +XmCChildPlacement +unsigned char +XmPLACE_ABOVE_SELECTION +CSG + + +XmNdialogType +XmCDialogType +unsigned char +XmDIALOG_COMMAND +G + + +XmNhelpLabelString +XmCHelpLabelString +XmString +dynamic +N/A + + +XmNlistItemCount +XmCItemCount +int +0 +CSG + + +XmNlistItems +XmCItems +XmStringTable +NULL +CSG + + +XmNlistLabelString +XmCListLabelString +XmString +NULL +N/A + + +XmNlistVisibleItemCount +XmCVisibleItemCount +int +dynamic +CSG + + +XmNminimizeButtons +XmCMinimizeButtons +Boolean +False +N/A + + +XmNmustMatch +XmCMustMatch +Boolean +False +N/A + + +XmNnoMatchCallback +XmCCallback +XtCallbackList +NULL +N/A + + +XmNokCallback +XmCCallback +XtCallbackList +NULL +N/A + + +XmNokLabelString +XmCOkLabelString +XmString +dynamic +N/A + + +XmNselectionLabelString +XmCSelectionLabelString +XmString +dynamic +CSG + + +XmNtextAccelerators +XmCTextAccelerators +XtAccelerators +default +C + + +XmNtextColumns +XmCColumns +short +dynamic +CSG + + +XmNtextString +XmCTextString +XmString +"" +CSG + + + + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +False +N/A + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +N/A + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +NULL +N/A + + +XmNdefaultButton +XmCWidget +Widget +NULL +N/A + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +False +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_NONE +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + XmString value; + int length; +} XmCommandCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +value + +Specifies the XmString in the CommandArea + + + + +length + +Specifies the size in bytes of the XmString value. +This member is obsolete and exists for compatibility with +earlier releases. + + + + + + + + + + + + + + + + +Translations +XmCommand inherits translations from XmSelectionBox. + + + +Accelerators +The XmNtextAccelerators from XmSelectionBox are added to the Text +descendant of XmCommand. + + + +Action Routines +The XmCommand action routines are: + + + +SelectionBoxUpOrDown(Previous|Next|First|Last): + +When called with an argument of Previous, or 0 (zero) for +compatibility, +selects the previous item in the history +list and replaces the text with that item. + +When called with an argument of Next, or 1 for +compatibility, selects the next item in the history +list and replaces the text with that item. + +When called with an argument of First, or 2 for +compatibility, selects the first item in the history +list and replaces the text with that item. + +When called with an argument of Last, or 3 for +compatibility, selects the last item in the history +list and replaces the text with that item. + +Calls the callbacks for XmNcommandChangedCallback. + + + + + + +Additional Behavior +The Command widget has the following additional behavior: + + + +KeyosfCancel: + +If the parent of the Command is a manager, the event is passed to the parent. + + + + +KeyosfActivate in Text: + +Calls the Text widget's XmNactivateCallback callbacks. +If the text is empty, this action then returns. +Otherwise, if the history list has XmNhistoryMaxItems items, it +removes the first item in +the list. +It adds the text to the history list as the last item, clears the text, +and calls the XmNcommandEnteredCallback callbacks. + + + + +Key in Text: + +When any change is made to the text edit widget, this action +calls the callbacks for +XmNcommandChangedCallback. + + + + +BtnDown(2+) or KeyosfActivate in List: + +Calls the List widget's XmNdefaultActionCallback callbacks. +If the history list has XmNhistoryMaxItems items, this action +removes the first item in the list. +It adds the selected List item to the history list as the last item, +clears the text, and calls the XmNcommandEnteredCallback +callbacks. + + + + +FocusIn: + +Calls the callbacks for XmNfocusCallback. + + + + +MapWindow: + +When a Command that is the child of a DialogShell is mapped, this action +calls the callbacks for XmNmapCallback. + + + + +UnmapWindow: + +When a Command that is the child of a DialogShell is unmapped, this +action calls the +callbacks for XmNunmapCallback. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmBulletinBoard;, +&cdeman.XmCommandAppendValue;, +&cdeman.XmCommandError;, +&cdeman.XmCommandGetChild;, +&cdeman.XmCommandSetValue;, +&cdeman.XmCreateCommand;, +&cdeman.XmManager;, and +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainA.sgm new file mode 100644 index 00000000..3e96b397 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainA.sgm @@ -0,0 +1,3803 @@ + + + + + + + + + + + +XmContainer +library call + + +XmContainer +The Container widget class + +XmContainer + +container +Container + + + + + + + + + + + + + + +&npzwc;#include <Xm/Container.h> + + + +DESCRIPTION +Container manages child widgets that have the ContainerItem trait. +These child widgets can be viewed in several different +layout formats, +selected using different selection types and techniques, +and directly manipulated by the user. + +Three different formats or views are supported by the Container. +They are specified via the XmNentryViewType resource: + + + +XmLARGE_ICON + + + +XmSMALL_ICON + + + +XmANY_ICON + + + +Three different layout types are supported by the Container. +They are specified by the XmNlayoutType resource: + + + +XmSPATIAL + + + +XmOUTLINE + + + +XmDETAIL + + + +In the XmSPATIAL layout type, several other resources +(XmNspatialStyle, XmNspatialIncludeModel, XmNspatialSnapModel) +control the positioning of the items within the Container; +an application programmer can specify these resources so that the Container +strictly enforces the position of each item or so that the Container positions +items according to constraint resources specified for each item. +The user, however, can alter the position of an item in the XmSPATIAL +layout type +within the Container by direct manipulation; for example, by pressing +BTransfer over the item and then dragging and releasing +BTransfer +over some location within the Container. + +In the XmOUTLINE layout type, the Container controls the positioning of +the items. Items within the Container can have parent-child +relationships between them. Each item's XmNentryParent resource can +specify another item in the same Container as its parent; +items with a non-NULL value +for XmNentryParent can only be displayed in the XmOUTLINE layout +type. In the XmOUTLINE layout type, +items are positioned in a tree configuration with connecting lines drawn +to illustrate the relationships. +Items are positioned top to bottom in the order specified by +XmNpositionIndex within their parent. +Container positions a PushButton next to each item that has a parent +relationship to other items. The PushButton contains a pixmap to illustrate +whether the child items are shown or not; the user can activate the +PushButton to toggle between showing or hiding the child items. +Direct manipulation to alter the +position of the item is not supported in the XmOUTLINE layout +type. +Note that the XmNtraversalOn resource of the PushButtons created +by Container are set to False. + +The XmDETAIL layout type is the same as XmOUTLINE, except that +each item can also display additional information as rows in +columns with column headers specified in the XmNdetailColumnHeading +resources. In each item row, the item's detail information +(see the reference page on XmIconGadget for a description of the +XmNentryDetail resource) +is displayed. Items are positioned top to bottom +in the order specified by +XmNpositionIndex within the parent. + + +Selection +When a child widget of the container is selected, the container +specifies that the item should display the appropriate visual +information to the user via the ContainerItem trait. +The application program is notified of selection +changes through XmNselectionCallback. + +The container uses four selection policies: + + + +Single + + + +Browse + + + +Multiple + + + +Extended + + + +In Single Select and Browse Select modes, only one item can be selected at a +time. Pressing BSelect +on an item selects it and deselects any other selected item. +Pressing BSelect over an empty space in the Container deselects +all items. In Browse Select, dragging BSelect moves the selection +as the pointer is moved. + +In Multiple Select and Extended Select modes, any number of items can be +selected at the same time. +In Multiple Select, pressing and dragging BSelect or +BExtend to specify an item, range of items, or group of discontiguous +items +causes the selection states of those items to be toggled. In Extended Select, +pressing and dragging BSelect to indicate an item, range of items, +or group of discontiguous +items selects those items and deselects all others. Pressing +and dragging BExtend in Extended Select to indicate an item, +range of items, or discontiguous group of items causes the selection states +of those items to be toggled. + +Several techniques are available to indicate an item, range of items, or +group of discontiguous items in the Multiple Select and Extended Select modes. + +In the XmSPATIAL and XmOUTLINE layout types, +the XmNselectionTechnique resource specifies the techniques to be used +to indicate items. The default specification of XmTOUCH_OVER +allows both the Random-Swipe and Marquee techniques to be used when +XmNlayoutStyle is XmSPATIAL. The default specification of +XmTOUCH_OVER allows the Range-Swipe, Range-Click, and Marquee techniques +to be used when XmNlayoutStyle is XmOUTLINE. + +Discontiguous groups of items can be selected using the Random-Swipe +technique. +In the Random-Swipe +technique, pressing BSelect (or BExtend) over an item and dragging +BSelect over other items selects all of those items. Only those +items that pointer passed over are selected. + +In the Range-Swipe +technique, the user presses BSelect (or BExtend) over the first +item and releases BSelect over the last item; all items within the range +between the first and last item are selected whether the pointer actually +passed over them or not. +In the Range-Click technique, the user presses and releases +BSelect (or BExtend) over the first item and then presses and +releases BExtend over the last item. + +In the Marquee technique, pressing BSelect (or BExtend) +over a blank space within the +Container indicates the starting point of a Marquee rectangle. Dragging +BSelect draws a Marquee rectangle (rubberband line) between the +starting point and current pointer. All items completely within the Marquee +rectangle are selected. + +Specifying XmTOUCH_ONLY for XmNselectionTechnique enforces +the Random-Swipe technique even when BSelect (or BExtend) +is pressed over a blank space. +Similarly, specifying XmMARQUEE enforces the +Marquee technique even when BSelect (or BExtend) +is pressed over an item; since the item over which the press occurs is +only partially included in the Marquee rectangle, it is not selected. +XmMARQUEE_EXTEND_START and XmMARQUEE_EXTEND_BOTH enforce the +Marquee technique and also cause the rectangle to extend automatically around +the first item indicated and, for XmMARQUEE_EXTEND_BOTH, the last item. + +In the XmDETAIL layout type, the Range-Swipe and +Range-Click techniques +are available to indicate a range of items for selection. + +Container uses the XmQTcontainerItem, XmQTscrollFrame, and +XmQTspecifyRenderTable +traits and holds the +XmQTcontainer and XmQTtransfer traits. + + + +Data Transfer Behavior +Container supports dragging of selected items from the widget. +Depending on the value of XmNprimaryOwnership, Container can also +support primary selection. + +As a source of data, Container supports the following targets and +associated conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers the selected items in the encoding of the locale. +The value for each item transferred, except the last, includes a trailing +separator. +Each item value is the XmNlabelString of the +item. + + + + +COMPOUND_TEXT + +The widget transfers the selected items as type COMPOUND_TEXT. +The value for each item transferred, except the last, includes a trailing +separator. +Each item value is the XmNlabelString of the +item. + + + + +DELETE + +The widget deletes the selected items. + + + + +PIXMAP + +The widget transfers a list of the pixmap IDs of the selected items as +type DRAWABLE. + + + + +STRING + +The widget transfers the selected items as type STRING. +The value for each item transferred, except the last, includes a trailing +separator. +Each item value is the XmNlabelString of the +item. + + + + +TEXT + +If the selected items are fully convertible to the encoding of the +locale, the widget transfers the selected items in the encoding of the +locale. +Otherwise, the widget transfers the selected items as type +COMPOUND_TEXT. +The value for each item transferred, except the last, includes a trailing +separator. +Each item value is the XmNlabelString of the +item. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for immediate transfer for the CLIPBOARD selection. +These include _MOTIF_COMPOUND_STRING and PIXMAP. +If the selected items are fully convertible to STRING, these also +include STRING; otherwise, they also include COMPOUND_TEXT. + + + + +_MOTIF_COMPOUND_STRING + +The widget transfers the selected items as a compound string in +Byte Stream format. +The value for each item transferred, except the last, includes a trailing +separator. +Each item value is the XmNlabelString of the +item. + + + + +_MOTIF_DEFERRED_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for delayed transfer for the CLIPBOARD selection. +This widget currently supplies no targets for +_MOTIF_DEFERRED_CLIPBOARD_TARGETS. + + + + +_MOTIF_DRAG_OFFSET + +The widget transfers a list of two 16-bit numbers, of type +INTEGER, representing an x and y offset for an item being dragged. +This offset is calculated so that, if the offset were added to the x and +y coordinates at the drop site, and the dragged pixmap placed at that +position, it would correspond to the position the user would expect the +pixmap to placed at, based on the drag icon used at the drop site. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +These include _MOTIF_COMPOUND_STRING, PIXMAP, +COMPOUND_TEXT, the encoding of the locale, STRING, +TEXT, BACKGROUND, and FOREGROUND. + + + + +As a source of data, Container also supports the following standard +Motif targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +These also include _MOTIF_COMPOUND_STRING, PIXMAP, +COMPOUND_TEXT, the encoding of the locale, STRING, and +TEXT. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + +As a destination for data, Container supports only the dropping of items +being dragged from the same widget. +Subclasses and the XmNdestinationCallback procedures are +responsible for any other data transfers to the widget. + + + +Classes +Container inherits behavior, resources, and traits from the Core, +Composite, Constraint, +and XmManager classes. + +The class pointer is xmContainerWidgetClass. + +The class name is XmContainer. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in a .Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in a .Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate whether the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmContainer Resource Set + + +Name +Class +Type +Default +Access + + +XmNautomaticSelection +XmCAutomaticSelection +unsigned char +XmAUTO_SELECT +CSG + + +XmNcollapsedStatePixmap +XmCCollapsedStatePixmap +Pixmap +dynamic +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdefaultActionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdestinationCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdetailColumnHeading +XmCDetailColumnHeading +XmStringTable +NULL +CSG + + +XmNdetailColumnHeadingCount +XmCDetailColumnHeadingCount +Cardinal +0 +CSG + + +XmNdetailOrder +XmCDetailOrder +Cardinal * +NULL +CSG + + +XmNdetailOrderCount +XmCDetailOrderCount +Cardinal +dynamic +CSG + + +XmNdetailTabList +XmCDetailTabList +XmTabList +NULL +CSG + + +XmNentryViewType +XmCEntryViewType +unsigned char +XmANY_ICON +CSG + + +XmNexpandedStatePixmap +XmCExpandedStatePixmap +Pixmap +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +NULL +CSG + + +XmNlargeCellHeight +XmCCellHeight +Dimension +dynamic +CSG + + +XmNlargeCellWidth +XmCCellWidth +Dimension +dynamic +CSG + + +XmNlayoutType +XmCLayoutType +unsigned char +XmSPATIAL +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +0 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +0 +CSG + + +XmNoutlineButtonPolicy +XmCOutlineButtonPolicy +unsigned char +XmOUTLINE_BUTTON_PRESENT +CSG + + +XmNoutlineChangedCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNoutlineColumnWidth +XmCOutlineColumnWidth +Dimension +dynamic +CSG + + +XmNoutlineIndentation +XmCOutlineIndentation +Dimension +40 +CSG + + +XmNoutlineLineStyle +XmCLineStyle +unsigned char +XmSINGLE +CSG + + +XmNprimaryOwnership +XmCprimaryOwnership +unsigned char +XmOWN_POSSIBLE_MULTIPLE +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNselectColor +XmCSelectColor +Pixel +dynamic +CSG + + +XmNselectedObjects +XmCSelectedObjects +WidgetList +NULL +SG + + +XmNselectedObjectCount +XmCSelectedObjectCount +unsigned int +0 +SG + + +XmNselectionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNselectionPolicy +XmCSelectionPolicy +unsigned char +XmEXTENDED_SELECT +CSG + + +XmNselectionTechnique +XmCSelectionTechnique +unsigned char +XmTOUCH_OVER +CSG + + +XmNsmallCellHeight +XmCCellHeight +Dimension +dynamic +CSG + + +XmNsmallCellWidth +XmCCellWidth +Dimension +dynamic +CSG + + +XmNspatialIncludeModel +XmCSpatialIncludeModel +unsigned char +XmAPPEND +CSG + + +XmNspatialResizeModel +XmCSpatialResizeModel +unsigned char +XmGROW_MINOR +CSG + + +XmNspatialSnapModel +XmCSpatialSnapModel +unsigned char +XmNONE +CSG + + +XmNspatialStyle +XmCSpatialStyle +unsigned char +XmGRID +CSG + + + + + + +XmNautomaticSelection + +Indicates whether the Container invokes selection callbacks when each +item is selected (or toggled) or whether selection callbacks are not +invoked until the user has completed selection actions (for example, +the user has released the mouse button). It can have one of the following +values: + + + +XmAUTO_SELECT + +Makes selection callbacks automatically when each +item is selected or toggled. This may also be the value TRUE. + + + + +XmNO_AUTO_SELECT + +Delays selection callbacks until the +user has finished selection actions. This may also be the value FALSE. + + + + + + + +XmNcollapsedStatePixmap + +Specifies the pixmap to display on a PushButton next to a Container item +with child items, when XmNoutlineButtonPolicy is +XmOUTLINE_BUTTON_PRESENT. +XmNcollapsedStatePixmap indicates that the child items are not displayed. +If set to XmUNSPECIFIED_PIXMAP, a default pixmap showing an +arrow pointing up is used. + + + + +XmNconvertCallback + +Specifies a list of callbacks called when the Container is asked to +convert a selection. +The type of the structure whose address is passed to these callbacks is +XmConvertCallbackStruct. +The reason is XmCR_OK. + + + + +XmNdefaultActionCallback + +Specifies a list of callbacks to call when the user double-clicks +an item or presses +Enter or +Return over an item. +The callback structure is XmContainerSelectCallbackStruct. +The reason is XmCR_DEFAULT_ACTION. + + + + +XmNdestinationCallback + +Specifies a list of callbacks called when the Container is the +destination of a transfer operation. +The type of the structure whose address is passed to these callbacks is +XmDestinationCallbackStruct. +The reason is XmCR_OK. + + + + +XmNdetailColumnHeading + +Specifies a table of XmStrings to display as the headings to columns. +If NULL, or if XmNlayoutType +is not XmDETAIL, no heading is displayed. + + + + +XmNdetailColumnHeadingCount + +Specifies a count of XmStrings in the table specified for +XmNdetailColumnHeading. + + + + +XmNdetailOrder + +Specifies an array of +Cardinals that indicate which column detail information, +and in which order, each Container child will display its detail information. +This resource is ignored if XmNlayoutType is not XmDETAIL. +If NULL, the the default behavior is determined by XmNdetailOrderCount. + + + + +XmNdetailOrderCount + +Specifies a count of Cardinals in the array specified for +XmNdetailOrder. +If XmNdetailOrder is NULL and XmNdetailOrderCount is not 0, then +each Container child displays its detail information in order from column +1 to the XmNdetailOrderCount column number. If XmNdetailOrderCount +is 0, then a default is calculated from the detail order count +information of each item accessed via the ContainerItem trait. + + + + +XmNdetailTabList + +Indicates an XmTabList specifying the start +of each column in the XmDETAIL layout. +If this resource is set to NULL, then Container calculates an XmTabList. +This resource is ignored if XmNlayoutType is not XmDETAIL. + + + + +XmNentryViewType + +Specifies the view type for all Container children. The view type is +specified for each item via the ContainerItem trait. +It can have one of the following values: + + + +XmANY_ICON + +No specification is made for Container children. Children use their own +default specifications. + + + + +XmLARGE_ICON + +The view type for all children is XmLARGE_ICON. + + + + +XmSMALL_ICON + +The view type for all children is XmSMALL_ICON. + + + + + + + +XmNexpandedStatePixmap + +Specifies the pixmap to display on a PushButton next to a Container item +with child items, when XmNoutlineButtonPolicy is +XmOUTLINE_BUTTON_PRESENT. +XmNexpandedStatePixmap indicates that the child items are displayed. +If set to XmUNSPECIFIED_PIXMAP, a default pixmap showing +an arrow pointing down is used. + + + + +XmNfontList + +Specifies the fontlist associated with XmContainer. The fontlist +is an obsolete construct and has been superseded by the render table. +It is included for compatibility with earlier versions of Motif, and +for applications that do not easily support render tables. The +default fontlist is derived from the default render table; and if +both a fontlist and a render table are specified, the render table +takes precedence. + + + + +XmNlargeCellHeight + +Specifies the height of a cell for XmGRID or +XmCELLS spatial style when +XmNentryViewType is XmLARGE_ICON or XmANY_ICON. + + + + +XmNlargeCellWidth + +Specifies the width of a cell for XmGRID or +XmCELLS spatial style when +XmNentryViewType is XmLARGE_ICON or XmANY_ICON. + + + + +XmNlayoutType + +Specifies the policy for laying out child widgets within the Container. +It can have one of the following values: + + + +XmDETAIL + +Displays items in the same manner as when the resource is XmOUTLINE, +except that each item displays detail information next to it. + + + + +XmOUTLINE + +Displays items in a tree configuration, +in XmNpositionIndex within XmNentryParent order, with connecting +lines drawn to show their parent-child relationships. + + + + +XmSPATIAL + +Displays items according to XmNspatialStyle. +Items with XmNentryParent values are not displayed. + + + + + + + +XmNmarginHeight + +Specifies the margin spacing at the top and bottom of the Container. + + + + +XmNmarginWidth + +Specifies the margin spacing at the left and right sides of the Container. + + + + +XmNoutlineButtonPolicy + +Specifies whether or not to display buttons for users to expand and collapse +the display of items. +It can have one of the following values: + + + +XmOUTLINE_BUTTON_ABSENT + +Do not display the outline buttons. + + + + +XmOUTLINE_BUTTON_PRESENT + +Display the outline buttons. + + + + + + + +XmNoutlineChangedCallback + +Specifies a list of callbacks to call when an item's XmNoutlineState +is changed. +The callback structure is XmContainerOutlineCallbackStruct. +The reason is XmCR_COLLAPSED or XmCR_EXPANDED, +depending on the new value of XmNoutlineState. + + + + +XmNoutlineColumnWidth + +Specifies the width of the first column displayed when XmNlayoutType +is XmDETAIL. Specifies the preferred width of the Container (without the +margins) when XmNlayoutType is XmOUTLINE. +If not specified, Container will determine a default value equal to the +widest space necessary to display an item's pixmap and +XmNoutlineIndentation. + + + + +XmNoutlineIndentation + +Specifies the distance to indent for the display of +child items when XmNlayoutType is XmOUTLINE or XmDETAIL. + + + + +XmNoutlineLineStyle + +Specifies whether to draw lines between items with parent-child +relationships when XmNlayoutType +is XmOUTLINE or XmDETAIL. +It can have one of the following values: + + + +XmNO_LINE + +Draws no line. + + + + +XmSINGLE + +Draws a line one pixel wide. + + + + + + + +XmNprimaryOwnership + +Specifies whether Container takes ownership of the primary selection when a +selection is made inside it. This resource can take the following values: + + + +XmOWN_NEVER + +Never takes ownership. + + + + +XmOWN_ALWAYS + +Always takes ownership. + + + + +XmOWN_MULTIPLE + +Only takes ownership if more than one element has been +selected. + + + + +XmOWN_POSSIBLE_MULTIPLE + +Only takes ownership if more than one element +can be selected at a time. + + + + + + + +XmNrenderTable + +Specifies the XmRenderTable that is inherited by all children +of the Container. +The default is implementation dependent. +If both a render table and a fontlist are specified, the render table +will take precedence. + + + + +XmNselectColor + +Specifies a Pixel that can be accessed by children of the Container and +used to indicate that the child is in a selected state. In addition to +a Pixel value, the following symbolic values can be specified: + + + +XmDEFAULT_SELECT_COLOR + +Specifies a color between the background and the bottom shadow color. + + + + +XmREVERSED_GROUND_COLORS + +Forces the select color to the foreground color and causes the default color +of any text rendered over the select color to be the background color. + + + + +HIGHLIGHT_COLOR + +Forces the fill color to use the highlight color. + + + + + + + +XmNselectedObjectCount + +Specifies the number of widgets in the selected items list. +The value must be the number of items in XmNselectedObjects. + + + + +XmNselectedObjects + +An array of widgets that represents the Container items that +are currently selected, either by the user or by the application. + +If the application sets XmNselectedObjects to an array of widgets, +those array elements that are valid Container items are selected. + + + + +XmNselectionCallback + +Specifies a list of callbacks to call when an item is selected. +The callback structure is XmContainerSelectCallbackStruct. +The reason is XmCR_SINGLE_SELECT, XmCR_BROWSE_SELECT, +XmCR_MULTIPLE_SELECT, or XmCR_EXTENDED_MULTIPLE, depending on +XmNselectionPolicy. + + + + +XmNselectionPolicy + +Defines the interpretation of the selection action. This can be one of the +following values: + + + +XmSINGLE_SELECT + +Allows only single selections. + + + + +XmBROWSE_SELECT + +Allows "drag and browse" selections. + + + + +XmMULTIPLE_SELECT + +Allows multiple selections. + + + + +XmEXTENDED_SELECT + +Allows extended selections. + + + + + + + +XmNselectionTechnique + +Specifies the selection technique to use when the Container displays +items in a 2-dimensional layout +(XmNentryViewType is XmLARGE_ICON or XmSMALL_ICON). +In the XmDETAIL layout, the XmNselectionTechnique +resource is treated as XmTOUCH_ONLY. In either case, +it can have one of the following +values: + + + +XmMARQUEE + +Uses the Marquee technique only. + + + + +XmMARQUEE_EXTEND_START + +Uses the Marquee technique only and extends +the Marquee rectangle around any item under the Marquee start point. + + + + +XmMARQUEE_EXTEND_BOTH + +Uses the Marquee technique only and extends +the Marquee rectangle around any items under the Marquee start and end points. + + + + +XmTOUCH_ONLY + +Uses the Random-Swipe technique only if +XmNlayoutType is XmSPATIAL. +Otherwise, uses the Range-Swipe and Range-Click techniques. + + + + +XmTOUCH_OVER + +If the selection action begins over an item +and XmNlayoutType is XmSPATIAL, uses +the Random-Swipe technique. +If the selection action begins over an item +and XmNlayoutType is XmOUTLINE or XmDETAIL, uses +the Range-Swipe and Range-Click techniques. +Uses the Marquee technique if the select action +begins over an unoccupied area in the Container. + + + + + + + +XmNsmallCellHeight + +Specifies the height of a cell for XmGRID or +XmCELLS spatial style when +XmNentryViewType is XmSMALL_ICON. + + + + +XmNsmallCellWidth + +Specifies the width of a cell for XmGRID or +XmCELLS spatial style when +XmNentryViewType is XmSMALL_ICON. + + + + +XmNspatialIncludeModel + +Specifies the layout of an item when the item is managed +in the Container when XmNlayoutType is +XmSPATIAL and XmNspatialStyle is XmGRID or XmCELLS. +It can have one of the following values: + + + +XmAPPEND + +Places the item after the last occupied cell according to +XmNlayoutDirection. + + + + +XmCLOSEST + +Places the item in the free cell closest to the position +specified by XmNx and XmNy. + + + + +XmFIRST_FIT + +Places the item in the first free cell +according to XmNlayoutDirection. + + + + + + + +XmNspatialResizeModel + +Specifies how Container will attempt to grow its dimensions +when XmNlayoutType is +XmSPATIAL and XmNspatialStyle is XmGRID or XmCELLS +and there are not enough cells to contain a new Container item. +It can have one of the following values: + + + +XmGROW_BALANCED + +Container will request both width and height growth from its parent. + + + + +XmGROW_MAJOR + +Container will request growth in its major dimension from its parent. +Container's major dimension is width when the precedence of +XmNlayoutDirection is horizontal, and height when vertical. + + + + +XmGROW_MINOR + +Container will request growth in its minor dimension from its parent. +Container's minor dimension is height when the precedence of +XmNlayoutDirection is horizontal, and width when vertical. + + + + + + + +XmNspatialSnapModel + +Specifies how Container will position an item within the cell layout +when XmNlayoutType is +XmSPATIAL and XmNspatialStyle is XmGRID or XmCELLS. +It can have one of the following values: + + + +XmCENTER + +Center the items as follows, depending on the value of XmNentryViewType: + + + +XmLARGE_ICON + +The child is centered in +the cell horizontally and baseline-aligned vertically. + + + + +XmSMALL_ICON + +The child is centered in the cell vertically on its baseline and aligned +with the left or right of the cell horizontally, depending on +the value of XmNlayoutDirection. + + + + + + + +XmSNAP_TO_GRID + +Position the item at the upper-left or upper-right corner of the cell(s), +depending on the value of XmNlayoutDirection. + + + + +XmNONE + +Position the item according to the position +specified by XmNx and XmNy. +If the position is not within the coordinates of the cell(s), +then position the item at the upper-left or upper-right corner of the cell(s), +depending on the value of XmNlayoutDirection. + + + + + + + +XmNspatialStyle + +Specifies the layout of Container items when XmNlayoutType is +XmSPATIAL. It can have one of the following values: + + + +XmCELLS + +Lays out items within a grid of same-size cells. +Each item occupies as many cells as required to contain the item dimensions. + + + + +XmGRID + +Lays out items within a grid of same-size cells. +Each item occupies only one cell. Items that are larger than the cell +size may overlap other items. + + + + +XmNONE + +Lays out items according to XmNx and +XmNy. + + + + + + + + + + + + + + + + + +XmContainer Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNentryParent +XmCWidget +Widget +NULL +CSG + + +XmNoutlineState +XmCOutlineState +unsigned char +XmCOLLAPSED +CSG + + +XmNpositionIndex +XmCPositionIndex +int +dynamic +CSG + + + + + + +XmNentryParent + +Specifies the widget that is this item's logical parent. +A value of NULL indicates that this is a root-level item. Parent-child +information is displayed only when the XmNlayoutPolicy is XmOUTLINE +or XmDETAIL. + + + + +XmNoutlineState + +Specifies whether to display child items when XmNlayoutPolicy is +XmOUTLINE or XmDETAIL. +It can have one of the following values: + + + +XmCOLLAPSED + +Does not display child items. + + + + +XmEXPANDED + +Displays child items. + + + + + + + +XmNpositionIndex + +Specifies the order of items in the Container for display. +When XmNlayoutType is XmOUTLINE or XmDETAIL, items are +displayed in XmNpositionIndex order within XmNentryParent. +Items that +have an XmNentryParent resource are ignored when XmNlayoutType is +XmSPATIAL. +If XmNpositionIndex is not specified, it defaults to the +XmNpositionIndex value plus 1 of the item with the highest +XmNpositionIndex that has the same XmNentryParent if such +an item exists; otherwise, it defaults to 0. + + + + + + +Inherited Resources +Container inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to callbacks for +XmNoutlineChangedCallback. + +typedef struct +{ + int reason; + XEvent * event; + Widget item; + unsigned char new_outline_state; +} XmContainerOutlineCallbackStruct; + + +reason + +Specifies the reason for the callback. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +item + +Specifies the container item affected by the event. + + + + +new_outline_state + +Specifies the next XmNoutlineState for item. The user can +change this value in the callback. + + + + +A pointer to the following structure is passed to callbacks for +XmNdefaultActionCallback and XmNselectionCallback. + +typedef struct +{ + int reason; + XEvent * event; + WidgetList selected_items; + int selected_item_count; + unsigned char auto_selection_type; +} XmContainerSelectCallbackStruct; + + +reason + +Specifies the reason for the callback. It corresponds to the +XmNselectionPolicy at the time the selection was made, or indicates +that the default action should be taken. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +selected_items + +Specifies a list of items selected at the time of the event that +caused the callback. +The selected_items field points to a temporary storage space +that is reused +after the callback is finished. +Therefore, if an application needs to save the selected list, it should +copy the list into its own data space. + + + + +selected_item_count + +Specifies the number of items in the selected_items list. +This number must be positive or 0 (zero). + + + + +auto_selection_type + +Indicates the cause of the selection when XmNautomaticSelection is +XmAUTO_SELECT. Valid values are the following: + + + +XmAUTO_UNSET + +Returned when XmNautomaticSelection is +XmNO_AUTO_SELECT. + + + + +XmAUTO_BEGIN + +Indicates the beginning of automatic selection. + + + + +XmAUTO_MOTION + +Indicates that there is a button drag selection. + + + + +XmAUTO_CANCEL + +Indicates that the new selection is canceled. + + + + +XmAUTO_NO_CHANGE + +Indicates that the currently selected item matches the initial item. + + + + +XmAUTO_CHANGE + +Indicates that the currently selected item does not match the initial item. + + + + + + + + +A pointer to the following structure is passed to the +XmNconvertCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + Atom target; + XtPointer source_data; + XtPointer location_data; + int flags; + XtPointer parm; + int parm_format; + unsigned long parm_length; + int status; + XtPointer value; + Atom type; + int format; + unsigned long length; +} XmConvertCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which conversion is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, +and _MOTIF_DROP. + + + + +target + +Indicates the conversion target. + + + + +source_data + +Contains information about the selection source. +When the selection is _MOTIF_DROP, source_data is the +DragContext. +Otherwise, it is NULL. + + + + +location_data + +Contains information about the location of data to be converted. +If the value is NULL, the data to be transferred consists of the +widget's current selection. +Otherwise, it is the widget ID of the item being transferred, or the +widget ID of the Container if all items are being transferred. + + + + +flags + +Indicates the status of the conversion. Following are the possible +values: + + + +XmCONVERTING_NONE + +This flag is currently unused. + + + + +XmCONVERTING_PARTIAL + +The target widget was able to be converted, but some data was lost. + + + + +XmCONVERTING_SAME + +The conversion target is the source of the data to be transferred. + + + + +XmCONVERTING_TRANSACT + +This flag is currently unused. + + + + + + + +parm + +Contains parameter data for this target. +If no parameter data exists, the value is NULL. + +When selection is CLIPBOARD and target is +_MOTIF_CLIPBOARD_TARGETS or +_MOTIF_DEFERRED_CLIPBOARD_TARGETS, the value is the requested +operation (XmCOPY, XmMOVE, or XmLINK). + + + + +parm_format + +Specifies whether the data in parm should be viewed +as a list of char, short, or long quantities. +Possible values are 0 (when parm is NULL), +8 (when the data in parm should be viewed as a list of chars), +16 (when the data in parm should be viewed as a list of shorts), +or 32 (when the data in parm should be viewed as a list of longs). +Note that parm_format symbolizes a data type, not the number of bits +in each list element. +For example, on some machines, a parm_format of 32 means that +the data in parm should be viewed as a list of 64-bit quantities, +not 32-bit quantities. + + + + +parm_length + +Specifies the number of elements of data in parm, where each +element has the size specified by parm_format. +When parm is NULL, the value is 0. + + + + +status + +An IN/OUT member that specifies the status of the conversion. +The initial value is XmCONVERT_DEFAULT. +The callback procedure can set this member to one of the following +values: + + + +XmCONVERT_DEFAULT + +The widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it +overwrites the data provided by the callback procedures in the value +member. + + + + +XmCONVERT_MERGE + +The widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it appends +its data to the data provided by the callback procedures in the +value member. +This value is intended for use with targets that result in lists of +data, such as TARGETS. + + + + +XmCONVERT_DONE + +The callback procedure has successfully finished +the conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + +XmCONVERT_REFUSE + +The callback procedure has terminated the +conversion process without completing the requested conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + + + + +value + +An IN/OUT parameter that contains any data that the callback procedure +produces as a result of the conversion. +The initial value is NULL. +If the callback procedure sets this member, it must ensure that the +type, format, and length members correspond +to the data in value. +The callback procedure is responsible for allocating, but not for +freeing, memory when it sets this member. + + + + +type + +An IN/OUT parameter that indicates the type of the data in the +value member. +The initial value is INTEGER. + + + + +format + +An IN/OUT parameter that specifies whether the data in value should +be viewed as a list of char, short, or long quantities. +The initial value is 8. +The callback procedure can set this member to 8 (for a list of char), +16 (for a list of short), or 32 (for a list of long). + + + + +length + +An IN/OUT member that specifies the number of elements of data in +value, where each element has the size symbolized by format. +The initial value is 0 (zero). + + + + +A pointer to the following callback structure is passed to the +XmNdestinationCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + XtEnum operation; + int flags; + XtPointer transfer_id; + XtPointer destination_data; + XtPointer location_data; + Time time; +} XmDestinationCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which data transfer is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, and +_MOTIF_DROP. + + + + +operation + +Indicates the type of transfer operation requested. + + + +When the selection is PRIMARY, possible values are XmMOVE, +XmCOPY, and XmLINK. + + + +When the selection is SECONDARY or CLIPBOARD, possible +values are XmCOPY and XmLINK. + + + +When the selection is _MOTIF_DROP, possible values are +XmMOVE, XmCOPY, XmLINK, and XmOTHER. +A value of XmOTHER means that the callback procedure must get +further information from the XmDropProcCallbackStruct in the +destination_data member. + + + + + + +flags + +Indicates whether or not the destination widget is also the source of +the data to be transferred. +Following are the possible values: + + + +XmCONVERTING_NONE + +The destination widget is not the source of the data to be transferred. + + + + +XmCONVERTING_SAME + +The destination widget is the source of the data to be transferred. + + + + + + + +transfer_id + +Serves as a unique ID to identify the transfer transaction. + + + + +destination_data + +Contains information about the destination. +When the selection is _MOTIF_DROP, the callback procedures are +called by the drop site's XmNdropProc, and destination_data +is a pointer to the XmDropProcCallbackStruct passed to the +XmNdropProc procedure. +When the selection is SECONDARY, destination_data is an Atom +representing a target recommmended by the selection owner for use in +converting the selection. +Otherwise, destination_data is NULL. + + + + +location_data + +Contains information about the location where data is to be transferred. +The value is always NULL when the selection is SECONDARY or +CLIPBOARD. +If the value is NULL, the data is to be inserted at the widget's cursor +position. +Otherwise, the value is a pointer to an XPoint structure +containing the x and y coordinates at the location where the data is to +be transferred. +Once XmTransferDone procedures start to be called, +location_data will no longer be stable. + + + + +time + +Indicates the time when the transfer operation began. + + + + + + + + + + + + + + +Translations +The XmContainer translations are listed below. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +≈c ≈s ≈m ≈a Btn1Down: + +ContainerBeginSelect() + + + + +Btn1Motion: + +ContainerButtonMotion() + + + + +≈c ≈s ≈m ≈a Btn1Up: + +ContainerEndSelect() + + + + +c ≈s ≈m ≈a Btn1Down: + +ContainerBeginToggle() + + + + +c ≈s ≈m ≈a Btn1Up: + +ContainerEndToggle() + + + + +≈c s ≈m ≈a Btn1Down: + +ContainerBeginExtend() + + + + +≈c s ≈m ≈a Btn1Up: + +ContainerEndExtend() + + + + +c s ≈m ≈a Btn1Down: + +ContainerBeginExtend() + + + + +c s ≈m ≈a Btn1Up: + +ContainerEndExtend() + + + + +≈c ≈s ≈m ≈a Btn2Down: + +ContainerStartTransfer(Copy) + + + + +c s ≈m ≈a Btn2Down: + +ContainerStartTransfer(Link) + + + + +≈c s ≈m ≈a Btn2Down: + +ContainerStartTransfer(Move) + + + + +≈m ≈a Btn2Up: + +ContainerEndTransfer() + + + + +:c s a KeyosfInsert: + +ContainerPrimaryLink() + + + + +:c s m KeyosfInsert: + +ContainerPrimaryLink() + + + + +:a KeyosfInsert: + +ContainerPrimaryCopy() + + + + +:m KeyosfInsert: + +ContainerPrimaryCopy() + + + + +:s a KeyosfDelete: + +ContainerPrimaryMove() + + + + +:s m KeyosfDelete: + +ContainerPrimaryMove() + + + + +:KeyosfCancel: + +ContainerCancel() + + + + +:s KeyosfSelect: + +ContainerExtend() + + + + +:KeyosfSelect: + +ContainerSelect() + + + + +:KeyosfSelectAll: + +ContainerSelectAll() + + + + +:KeyosfDeselectAll: + +ContainerDeselectAll() + + + + +:KeyosfAddMode: + +ContainerToggleMode() + + + + +:KeyosfActivate: + +ContainerActivate() + + + + +s ≈c ≈m ≈a Keyspace: + +ContainerExtend() + + + + +≈s ≈c ≈m ≈a Keyspace: + +ContainerSelect() + + + + +≈s ≈c ≈m ≈a KeyReturn: + +ContainerActivate() + + + + +≈s c ≈m ≈a Keyslash: + +ContainerSelectAll() + + + + +≈s c ≈m ≈a Keybackslash: + +ContainerDeselectAll() + + + + +:c s KeyosfBeginLine: + +ContainerExtendCursor(First) + + + + +:c s KeyosfEndLine: + +ContainerExtendCursor(Last) + + + + +:c KeyosfBeginLine: + +ContainerMoveCursor(First) + + + + +:c KeyosfEndLine: + +ContainerMoveCursor(Last) + + + + +:c KeyosfLeft: + +ContainerExpandOrCollapse(Left) + + + + +:c KeyosfRight: + +ContainerExpandOrCollapse(Right) + + + + +:s KeyosfUp: + +ContainerExtendCursor(Up) + + + + +:s KeyosfDown: + +ContainerExtendCursor(Down) + + + + +:s KeyosfLeft: + +ContainerExtendCursor(Left) + + + + +:s KeyosfRight: + +ContainerExtendCursor(Right) + + + + +:KeyosfUp: + +ContainerMoveCursor(Up) + + + + +:KeyosfDown: + +ContainerMoveCursor(Down) + + + + +:KeyosfLeft: + +ContainerMoveCursor(Left) + + + + +:KeyosfRight: + +ContainerMoveCursor(Right) + + + + +s ≈m ≈a KeyTab: + +ManagerGadgetPrevTabGroup() + + + + +≈s ≈m ≈a KeyTab: + +ManagerGadgetNextTabGroup() + + + + + +The Container button event translations are modified when Display's +XmNenableBtn1Transfer resource does not have a value of +XmOFF (in other words, it is either XmBUTTON2_TRANSFER or +XmBUTTON2_ADJUST). This +option allows the +actions for selection and transfer to be integrated on Btn1, and +the actions for extending the selection can be bound to +Btn2. The actions for Btn1 that are defined in the +preceding list +still apply when the Btn1 event occurs over text that is not +selected. The following actions apply when the Btn1 event +occurs over text that is selected: + + + +~c ~s ~m ~a Btn1Down: + +ContainerHandleBtn1Down(ContainerBeginSelect,Copy) + + + + +c ~s ~m ~a <Btn1Down>: + +ContainerHandleBtn1Down(ContainerBeginToggle,Copy) + + + + +c s ~m ~a <Btn1Down>: + +ContainerHandleBtn1Down(ContainerNoop,Link) + + + + +~c s ~m ~a <Btn1Down>: + +ContainerHandleBtn1Down(ContainerBeginExtend,Move) + + + + +Btn1Motion: + +ContainerHandleBtn1Motion(ContainerButtonMotion) + + + + +~c ~s ~m ~a <Btn1Up>: + +ContainerHandleBtn1Up(ContainerEndSelect) + + + + +c ~s ~m ~a <Btn1Up>: + +ContainerHandleBtn1Up(ContainerEndToggle) + + + + +~c s ~m ~a <Btn1Up>: + +ContainerHandleBtn1Up(ContainerEndExtend) + + + + +c s ~m ~a <Btn1Down>: + +ContainerHandleBtn1Down(ContainerBeginExtend) + + + + +c s ~m ~a <Btn1Up>: + +ContainerHandleBtn1Up(ContainerEndExtend) + + + + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the following actions apply: + + + +~c ~s ~m ~a <Btn2Down>: + +ContainerHandleBtn2Down(ContainerStartTransfer,Copy) + + + + +c s ~m ~a <Btn2Down>: + +ContainerHandleBtn2Down(ContainerStartTransfer,Link) + + + + +~c s ~m ~a <Btn2Down>: + +ContainerHandleBtn2Down(ContainerStartTransfer,Move) + + + + +Btn2Motion: + +ContainerHandleBtn2Motion(ContainerButtonMotion) + + + + +~m ~a <Btn2Up>: + +ContainerHandleBtn2Up(ContainerEndTransfer) + + + + + + +Action Routines +The Container action routines are described below. +The current selections are always shown +with the background color specified by the XmNselectColor resource. + + + +ContainerActivate(): + +This action calls XmNdefaultActionCallback +with reason XmCR_DEFAULT_ACTION. + + + + +ContainerBeginExtend(): + +Simply returns if XmNselectionPolicy is XmSINGLE_SELECT or +XmBROWSE_SELECT. +Simply returns if XmNlayoutType is XmSPATIAL. + +Otherwise, this action sets the selection state of all items between +the anchor item and the item under the pointer to +the selection state of the anchor item. +The location cursor is moved to the item under the pointer. +If XmNautomaticSelection is XmAUTO_SELECT, the +XmNselectionCallback(s) is called with either XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT as the reason depending on +XmNselectionPolicy, and with auto_selection_type +XmAUTO_CHANGE. + + + + +ContainerBeginSelect(): + +If this is a second ContainerBeginSelect() action that has occurred +within the time specified by the display's multiclick time, this action calls +XmNdefaultActionCallback with reason +XmCR_DEFAULT_ACTION and returns. + +Otherwise, processing depends on the value of XmNselectionPolicy +as follows: + + + +XmSINGLE_SELECT + +This action deselects all items and toggles the item (if any) under the pointer. + + + + +XmBROWSE_SELECT + +This action deselects all items and toggles the item (if any) under the pointer. +This item is now the anchor item for further selection. +If XmNautomaticSelection is XmAUTO_SELECT and a change in any +item's selection state is made, the +XmNselectionCallback(s) +is called with reason XmCR_BROWSE_SELECT and +auto_selection_type XmAUTO_BEGIN. + + + + +XmMULTIPLE_SELECT + +If the pointer is over an item and XmNselectionTechnique is not +XmMARQUEE, this action toggles the selection state of that item. +The item becomes the anchor item for further selection. +If XmNselectionTechnique is XmMARQUEE, XmMARQUEE_EXTEND_START, +or XmMARQUEE_EXTEND_BOTH, this action sets the start point for the +Marquee rectangle. +If XmNselectionTechnique is XmMARQUEE_EXTEND_START or +XmMARQUEE_EXTEND_BOTH and the pointer is over an item, this action +draws the Marquee rectangle around the item. +If XmNautomaticSelection is XmAUTO_SELECT, the +XmNselectionCallback(s) +is called with reason XmCR_MULTIPLE_SELECT and +auto_selection_type XmAUTO_BEGIN. + + + + +XmEXTENDED_SELECT + +All items are first deselected. Processing is then identical to the +case where XmNselectionPolicy is XmMULTIPLE_SELECT, except that +XmCR_EXTENDED_SELECT is the callback reason given if +XmNselectionCallback is called. + + + + + + + +ContainerBeginToggle(): + +Simply returns if XmNselectionPolicy is XmSINGLE_SELECT or +XmBROWSE_SELECT. + +Otherwise, if the pointer is over an item and XmNselectionTechnique is not +XmMARQUEE, this action toggles the selection state of that item. +The item becomes the anchor item for further selection. +If XmNselectionTechnique is XmMARQUEE, XmMARQUEE_EXTEND_START, +or XmMARQUEE_EXTEND_BOTH +this action sets the start point for the +Marquee rectangle. +If XmNselectionTechnique is XmMARQUEE_EXTEND_START or +XmMARQUEE_EXTEND_BOTH and the pointer is over an item, this action +draws the Marquee rectangle around the item. +If XmNautomaticSelection is XmAUTO_SELECT, the +XmNselectionCallback(s) is called with either XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT as the reason, depending on +XmNselectionPolicy, and with auto_selection_type XmAUTO_BEGIN. + + + + +ContainerButtonMotion(): + +Processing depends on the value of XmNselectionPolicy, as follows: + + + +XmSINGLE_SELECT + +This action simply returns to the caller. + + + + +XmBROWSE_SELECT + +Simply returns if this action follows a ContainerBeginExtend() +action or ContainerBeginToggle() action. + +If the pointer is no longer over the current anchor item, this action +toggles the current anchor item and then toggles the item under the pointer +(if any) and makes it the new anchor item for further processing. +If XmNautomaticSelection is XmAUTO_SELECT and a change in any item's +selection state is made, the +XmNselectionCallback(s) +is called with reason XmCR_BROWSE_SELECT and +auto_selection_type XmAUTO_MOTION. + + + + +XmMULTIPLE_SELECT + +If a previous action has set a Marquee rectangle start point, +this action draws the Marquee rectangle +between the current pointer position and the Marquee start point. If the +XmNselectionTechnique is XmMARQUEE_EXTEND_BOTH and the pointer is +over an item, the end point of the Marquee rectangle is extended to include +the item. The selection states of all items within the Marquee rectangle are +toggled to match the state of the anchor item. + +If no Marquee rectangle start point is set and the pointer is over an +item, processing depends on the XmNlayoutType resource. +The anchor item from the previous action is used. If +XmNlayoutType is XmSPATIAL, +the selection state of the item +under the pointer is toggled to match the selection state of the anchor item. +If XmNlayoutType is XmOUTLINE or +XmDETAIL, the selection state of all items between the anchor item +and the item under the pointer are toggled to match the selection state of +the anchor item. + +If XmNautomaticSelection is XmAUTO_SELECT and a change in any +item's selection state is made, the +XmNselectionCallback(s) is called with reason XmCR_MULTIPLE_SELECT +and auto_selection_type XmAUTO_MOTION. + + + + +XmEXTENDED_SELECT + +Processing is identical to the +case where XmNselectionPolicy is XmMULTIPLE_SELECT, except that +XmCR_EXTENDED_SELECT is the callback reason given if +XmNselectionCallback is called. + + + + + + + +ContainerCancel(): + +If a selection is in progress, this action +restores selection states of all items +to their state before the selection began. +If XmNautomaticSelection is True and a change in any item's +selection state is made, the +XmNselectionCallback is called with reason +XmCR_BROWSE_SELECT, XmMULTIPLE_SELECT, +or XmCR_EXTENDED_SELECT +depending on the +XmNselectionPolicy resource and auto_selection_type +XmAUTO_CANCEL. + + + + +ContainerDeselectAll(): + +This action deselects all items and calls XmNselectionCallback with +reason depending on XmNselectionPolicy. + + + + +ContainerEndExtend(): + +Simply returns if XmNselectionPolicy is XmSINGLE_SELECT or +XmBROWSE_SELECT. +Simply returns if XmNlayoutType is XmSPATIAL. + +Otherwise, +if XmNautomaticSelection is XmNO_AUTO_SELECT, +XmNselectionCallback(s) is called with either XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT as the reason depending on +XmNselectionPolicy. +If XmNautomaticSelection is XmAUTO_SELECT and no change +is made in any item's selection state by this action, +XmNselectionCallback(s) +is called with either XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT as the reason depending on +XmNselectionPolicy and +auto_selection_type XmAUTO_CHANGE. +If XmNautomaticSelection is XmAUTO_SELECT and this action makes no +change in any item's selection state, +XmNselectionCallback(s) +is called with either XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT as the reason depending on +XmNselectionPolicy and +auto_selection_type XmAUTO_NO_CHANGE. + + + + +ContainerEndSelect(): + +Processing depends on the value of XmNselectionPolicy, as follows: + + + +XmSINGLE_SELECT + +This action calls XmNselectionCallback +with reason XmCR_SINGLE_SELECT. + + + + +XmBROWSE_SELECT + +If the pointer is no longer over the current anchor item, this action +toggles the current anchor item and then toggles the item under the pointer +(if any). If XmNautomaticSelection is XmNO_AUTO_SELECT, +the +XmNselectionCallback(s) is called with reason XmCR_BROWSE_SELECT. +If XmNautomaticSelection is XmAUTO_SELECT and a change in any item's +selection state is made, +XmNselectionCallback(s) is called with reason XmCR_BROWSE_SELECT and +auto_selection_type XmAUTO_CHANGE. +If XmNautomaticSelection is XmAUTO_SELECT and no change +is made in any item's selection state by this action, +XmNselectionCallback(s) +is called with reason XmCR_BROWSE_SELECT and +auto_selection_type XmAUTO_NO_CHANGE. + + + + +XmMULTIPLE_SELECT + +This action first +performs the same processing as the ContainerButtonMotion() +action, except that XmNselectionCallback is not called. +If XmNautomaticSelection is XmNO_AUTO_SELECT, the +XmNselectionCallback(s) is called with reason XmCR_MULTIPLE_SELECT. +If XmNautomaticSelection is XmAUTO_SELECT and a change in any item's +selection state is made, the +XmNselectionCallback(s) +is called with reason XmCR_MULTIPLE_SELECT and +auto_selection_type XmAUTO_CHANGE. +If XmNautomaticSelection is XmAUTO_SELECT and this action makes no +change in any item's selection state, +XmNselectionCallback(s) +is called with reason XmCR_MULTIPLE_SELECT and +auto_selection_type XmAUTO_NO_CHANGE. + + + + +XmEXTENDED_SELECT + +This action first +performs the same processing as the ContainerButtonMotion() +action, except that XmNselectionCallback is not called. +If XmNautomaticSelection is XmNO_AUTO_SELECT, the +XmNselectionCallback(s) is called with reason XmCR_EXTENDED_SELECT. +If XmNautomaticSelection is XmAUTO_SELECT and a change in any item's +selection state is made, +XmNselectionCallback(s) +is called with reason XmCR_EXTENDED_SELECT and +auto_selection_type XmAUTO_CHANGE. +If XmNautomaticSelection is XmAUTO_SELECT and this action makes +no change in any item's selection state, +XmNselectionCallback(s) +is called with reason XmCR_EXTENDED_SELECT and +auto_selection_type XmAUTO_NO_CHANGE. + + + + + + + +ContainerEndToggle(): + +Simply returns if XmNselectionPolicy is XmSINGLE_SELECT or +XmBROWSE_SELECT. +If XmNselectionPolicy is XmMULTIPLE_SELECT or +XmEXTENDED_SELECT, this action performs the same processing as the +ContainerEndSelect() action. + + + + +ContainerEndTransfer():: + +If the elapsed time since a ContainerStartTransfer() +action has occurred exceeds the time +span specified by the display's multiclick time, this action returns. + +Otherwise, the ContainerPrimaryCopy(), ContainerPrimaryLink(), or +ContainerPrimaryMove() action is invoked, depending on the value +of the operation parameter saved by +ContainerStartTransfer(). + + + + +ContainerExpandOrCollapse(Left|Right|Collapse|Expand): + +This action changes the value of the XmNoutlineState of the +current focus widget. If the argument value is Collapse or +Left, the XmNoutlineState resource value is set to +XmCOLLAPSED. If the argument value is Expand +or Right, the XmNoutlineState resource value is set to +XmEXPANDED. + +If the argument is Left or Right and the layout is right to +left, then the setting of the XmNoutlineState value is reversed +from that described in the preceding paragraph. + +Simply returns if XmNlayoutType is XmSPATIAL. + + + + +ContainerExtend(): + +Processing depends on the value of XmNselectionPolicy, as follows: + +If the selection policy is XmSINGLE_SELECT or XmBROWSE_SELECT, +this action returns. +If XmNlayoutType is XmSPATIAL, this action returns. + +If the selection policy is XmMULTIPLE_SELECT, +this action sets the selection state +of all items between the anchor item and the location cursor to +the selection state of the anchor item. + +If the selection policy is XmEXTENDED_SELECT and the +Container is in Normal Mode, this action deselects all items and selects +all items between the anchor item and the location cursor. +If the selection policy is +XmEXTENDED_SELECT and the Container is in Add Mode, this action +sets the selection state +of all items between the anchor item and the location cursor to +the selection state of the anchor item. + +XmNselectionCallback is called with reason XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT depending on +XmNselectionPolicy. + + + + +ContainerExtendCursor(Left|Right|Up|Down): + +Processing depends on the value of XmNselectionPolicy, as follows: + +If the selection policy is XmSINGLE_SELECT or XmBROWSE_SELECT, +this action returns. +If XmNlayoutType is XmSPATIAL, this action returns. + +This action +moves the location cursor one item in the indicated direction, if possible. +If the value of the argument string is First or Last, this action +moves the location cursor to the indicated item. For other values of the +argument string, the location cursor is not affected. + +If the selection policy is XmMULTIPLE_SELECT, +this action sets the selection state +of all items between the anchor item and the location cursor to +the selection state of the anchor item. + +If the selection policy is XmEXTENDED_SELECT and the +Container is in Normal Mode, this action deselects all items and selects +all items between the anchor item and the location cursor. +If the selection policy is +XmEXTENDED_SELECT and the Container is in Add Mode, this action +sets the selection state +of all items between the anchor item and the location cursor to +the selection state of the anchor item. + +XmNselectionCallback is called with reason XmCR_MULTIPLE_SELECT +or XmCR_EXTENDED_SELECT depending on +XmNselectionPolicy. + + + + +ContainerHandleBtn1Down(string) + +When Display's XmNenableBtn1Transfer resource is not XmOFF, the +actions for selection and transfer are integrated on Btn1. +If the pointer is over an unselected item or background, the item is +first selected before +the transfer is started. Otherwise, if the item is already selected, the +transfer is started. +The value of string can be one of +the following actions: + + + +ContainerBeginSelect,Copy + + + +ContainerBeginToggle,Copy + + + +ContainerNoop,Link + + + +ContainerBeginExtend,Move + + + + + + +ContainerHandleBtn1Motion(string) + +When Display's XmNenableBtn1Transfer resource is not +XmOFF, the actions for selection +and transfer are integrated +on Btn1. When this action is invoked, and a selection is in +progress, a drag is performed. Otherwise, +the default +action as specified in string is performed. The value of string +can be ContainerButtonMotion. + + + + +ContainerHandleBtn1Up(string) + +If a Button 1 transfer was in progress, then when this action +is invoked, that +transfer is cancelled. Otherwise, +the default +action as specified in string is performed. The value of string +can be one of the following actions: + + + +ContainerEndSelect + + + +ContainerEndToggle + + + +ContainerEndExtend + + + + + + +ContainerHandleBtn2Down(string) + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the +actions for extending selection are bound on Btn2. Otherwise, +the action that is +performed depends on the value of string, which can be one of +the following actions: + + + +ContainerStartTransfer,Copy + + + +ContainerStartTransfer,Link + + + +ContainerStartTransfer,Move + + + + + + +ContainerHandleBtn2Motion(string) + +When Display's XmNenableBtn1Transfer resource is not +XmBUTTON2_ADJUST, and a selection is in +progress, a drag is performed. +Otherwise, the default action that is +performed depends on the value of string, which can be +ContainerButtonMotion. + + + + +ContainerHandleBtn2Up(string) + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, this action ends an extend. Otherwise, the action +that is performed depends on the value of string, which can be +ContainerEndTransfer. + + + + +ContainerMoveCursor(Left|Right|Up|Down|First|Last): + +If the argument is Left, Right, Up, or +Down, this action +moves the location cursor one item in the indicated direction, if possible. +If the value of the argument string is First or Last, this action +moves the location cursor to the indicated item. Any other arguments +are ignored. + +If XmNselectionPolicy is XmBROWSE_SELECT, +or if XmNselectionPolicy is XmEXTENDED_SELECT and the +Container is in Normal Mode, +this action deselects all items, selects the item at the location cursor, +and calls XmNselectionCallback with the reason depending on +XmNselectionPolicy. + + + + +ContainerPrimaryCopy(): + +This action requests that primary selection data be copied to the +Container. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmCOPY operation. +By default, the Container does not do any transfer, and copying the +selection is the responsibility of the XmNdestinationCallback +procedures. + + + + +ContainerPrimaryLink(): + +This action requests that primary selection data be linked to the +Container. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmLINK operation. +By default, the Container does not do any transfer, and linking the +selection is the responsibility of the XmNdestinationCallback +procedures. + + + + +ContainerPrimaryMove(): + +This action requests that primary selection data be copied to the +Container and deleted from the primary source. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmMOVE operation. +By default, the Container does not do any transfer, and moving the +selection is the responsibility of the XmNdestinationCallback +procedures. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the PRIMARY +selection and the DELETE target. + + + + +ContainerSelect(): + +Processing depends on the value of XmNselectionPolicy, as follows: + +If the selection policy is XmSINGLE_SELECT or XmBROWSE_SELECT, +this action deselects all items and selects the item at the location cursor. + +If the selection policy is XmMULTIPLE_SELECT, this action +toggles the selection state of the item at the location cursor. +This item becomes the anchor item for further selections. + +If the selection policy is XmEXTENDED_SELECT and the +Container is in Normal Mode, this action deselects all items and selects +the item at the location cursor. If the selection policy is +XmEXTENDED_SELECT and the Container is in Add Mode, this action +toggles the selection state of the item at the location cursor. +The selected/toggled item becomes the anchor item for further selections. + +XmNselectionCallback is called with the reason depending on +XmNselectionPolicy. + + + + +ContainerSelectAll(): + +If XmNselectionPolicy is XmSINGLE_SELECT or XmBROWSE_SELECT, +this action deselects all items and selects the item at the location cursor +position. + +If XmNselectionPolicy is XmMULTIPLE_SELECT +or XmEXTENDED_SELECT, this action selects all items. + +XmNselectionCallback is called with the +reason depending on the value +of XmNselectionCallback. + + + + +ContainerStartTransfer(Copy|Move|Link): + +This action saves the event and the operation specified in the argument +string for use by subsequent actions. +If no ContainerEndTransfer() actions occur within the time +span specified by the display's multiclick time and if XmNlayoutType +is XmSPATIAL, this action +creates a DragContext and starts a drag transfer by using string to +specify the transfer operation. If no argument string is +specified, Copy is the default value. + +Unless default drag and drop behavior has been overridden by a +XmNconvertCallback procedure, +if the drop operation occurs within the Container, then +the item(s) being dragged are relocated at the position of the +drop operation. If the item targeted by the Drag operation is +not in the selected state, then only that item is moved. If the item is +in the selected state, however, all items in the selected state are moved. + + + + +ContainerToggleMode(): + +If XmNselectionPolicy is XmEXTENDED_SELECT, this action +toggles the Container +between Normal Mode and Add Mode. + + + + + + +Additional Behavior +The Container widget has the following additional behavior: + + + +Btn1Down(2+) + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, the Container interprets +that as a double-click and calls the +XmNdefaultActionCallback callbacks. + + + + +FocusIn: + +If the focus policy is explicit, sets the focus and draws +the location cursor. + + + + +FocusOut: + +If the focus policy is explicit, removes the focus and erases +the location cursor. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +XmContainerCopy, +XmContainerCopyLink, +XmContainerCut, +XmContainerGetItemChildren, +XmContainerPaste, +XmContainerPasteLink, +&cdeman.XmContainerRelayout;, +&cdeman.XmContainerReorder;, +&cdeman.XmCreateContainer;, +&cdeman.XmCreateIconGadget;, +&cdeman.XmIconGadget;, and +&cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainB.sgm new file mode 100644 index 00000000..f3316e6b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainB.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmContainerCopy +library call + + +XmContainerCopy +Container widget function to copy primary selection +to the clipboard + +XmContainerCopy + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Boolean XmContainerCopy + +Widget container +Time timestamp + + + +DESCRIPTION +XmContainerCopy copies the primary selected container items to the +clipboard. +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmCOPY. + + + +container + +Specifies the Container widget ID. + + + + +timestamp + +Specifies the server time at which to modify the selection value. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +The function returns False in the following cases: if the primary selection +is NULL, if the widget does not own the primary selection, or if the function +is unable to gain ownership of the clipboard selection. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainC.sgm new file mode 100644 index 00000000..1e15f2c0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainC.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmContainerCopyLink +library call + + +XmContainerCopyLink +Container widget function to copy links +to the clipboard + +XmContainerCopyLink + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Boolean XmContainerCopyLink + +Widget container +Time timestamp + + + +DESCRIPTION +XmContainerCopyLink copies links to the primary selected items to +the clipboard. +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmLINK. +The Container widget itself does not copy any links; +XmNconvertCallback procedures are responsible for copying the link +to the clipboard and for taking any related actions. + + + +container + +Specifies the Container widget ID. + + + + +timestamp + +Specifies the server time at which to modify the selection value. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +The function returns False in the following cases: if the primary +selection is NULL, if the widget does not own the primary selection, or +if the function is unable to gain ownership of the clipboard selection. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainD.sgm new file mode 100644 index 00000000..fdc14683 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainD.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmContainerCut +library call + + +XmContainerCut +Container widget function to move items to the +clipboard + +XmContainerCut + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Boolean XmContainerCut + +Widget container +Time timestamp + + + +DESCRIPTION +XmContainerCut cuts the primary selected items to the clipboard. +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmMOVE. +If the transfer is successful, this routine then calls the +XmNconvertCallback procedures for the CLIPBOARD selection +and the DELETE target. + + + +container + +Specifies the Container widget ID. + + + + +timestamp + +Specifies the server time at which to modify the selection value. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +The function returns False in the following cases: if the primary selection +is NULL, if the widget does not own the primary selection, or if the function +is unable to gain ownership of the clipboard selection. Otherwise, it returns +True. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainE.sgm new file mode 100644 index 00000000..945e65ad --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainE.sgm @@ -0,0 +1,98 @@ + + + + + + + + + + + +XmContainerGetItemChildren +library call + + +XmContainerGetItemChildren +Container widget function to find +all children of an item + +XmContainerGetItemChildren + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +int XmContainerGetItemChildren + +Widget container +Widget item +WidgetList * item_children + + + +DESCRIPTION +XmContainerGetItemChildren allocates a WidgetList and stores within +it the widget IDs of all widgets that have item specified as the value +of their XmNentryParent resource. +The application programmer is responsible for freeing the allocated +WidgetList using XtFree. +The number of widget IDs returned +in item_children is returned by the function. If no widgets specify +item as the value of their XmNentryParent resource, +the function returns zero and item_children is left unchanged. + + + +container + +Specifies the Container widget ID. + + + + +item + +Specifies a widgetID within container. + + + + +item_children + +Returned array of Widgets. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +This function returns a count of all widgets that have item +specified as the value of their XmNentryParent resource. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainF.sgm new file mode 100644 index 00000000..0463b5ec --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainF.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +XmContainerPaste +library call + + +XmContainerPaste +Container widget function to insert items from the +clipboard + +XmContainerPaste + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Boolean XmContainerPaste + +Widget container + + + +DESCRIPTION +XmContainerPaste requests data transfer from the clipboard +selection to the Container. +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmCOPY. +The Container widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the clipboard selection and for taking any related actions. + + + +container + +Specifies the Container widget ID. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +The function returns False if no data transfer takes place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainG.sgm new file mode 100644 index 00000000..d13b6496 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainG.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +XmContainerPasteLink +library call + + +XmContainerPasteLink +Container widget function to insert links from the +clipboard + +XmContainerPasteLink + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Boolean XmContainerPasteLink + +Widget container + + + +DESCRIPTION +XmContainerPasteLink requests data transfer from the clipboard +selection to the Container. +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmLINK. +The Container widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the clipboard selection and for taking any related actions. + + + +container + +Specifies the Container widget ID. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +The function returns False if no data transfer takes place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainH.sgm new file mode 100644 index 00000000..91d0d5a4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainH.sgm @@ -0,0 +1,69 @@ + + + + + + + + + + + +XmContainerRelayout +library call + + +XmContainerRelayout +Container widget relayout function + +XmContainerRelayout + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +void XmContainerRelayout + +Widget container + + + +DESCRIPTION +XmContainerRelayout forces a layout of all items in the Container using +the XmNpositionIndex and XmNentryParent constraint resources +associated with each item. + + + +container + +Specifies the Container widget ID. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainI.sgm new file mode 100644 index 00000000..863edc79 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ContainI.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmContainerReorder +library call + + +XmContainerReorder +Container widget function to reorder children + +XmContainerReorder + +XmContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +void XmContainerReorder + +Widget container +WidgetList widgets +int num_widgets + + + +DESCRIPTION +XmContainerReorder obtains the XmNpositionIndex constraint +resources of each widget specified in widgets, sorts them in +ascending order, and inserts the XmNpositionIndex constraint +resources in the new order into each widget. +If the XmNlayoutType resource of Container is XmOUTLINE or +XmDETAIL, XmContainerReorder will force a layout of all +items. + + + +container + +Specifies the Container widget ID. + + + + +widgets + +Specifies an array of widget children of container. + + + + +num_widgets + +Specifies the number of items in the widgets array. + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArA.sgm new file mode 100644 index 00000000..2f5bfc3a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateArrowButton +library call + + +XmCreateArrowButton +The ArrowButton widget creation function + +XmCreateArrowButton + +creation functions +XmCreateArrowButton + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ArrowB.h> + +Widget XmCreateArrowButton + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateArrowButton creates an instance of an ArrowButton +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ArrowButton and its associated resources, see +&cdeman.XmArrowButton;. + + + +RETURN +Returns the ArrowButton widget ID. + + + +RELATED +&cdeman.XmArrowButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArB.sgm new file mode 100644 index 00000000..7e749422 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreArB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateArrowButtonGadget +library call + + +XmCreateArrowButtonGadget +The ArrowButtonGadget creation function + +XmCreateArrowButton\\%Gadget + +creation functions +XmCreateArrowButton\\%Gadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ArrowBG.h> + +Widget XmCreateArrowButtonGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateArrowButtonGadget creates an instance of an ArrowButtonGadget +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ArrowButtonGadget and its associated resources, see +&cdeman.XmArrowButtonGadget;. + + + +RETURN +Returns the ArrowButtonGadget widget ID. + + + +RELATED +&cdeman.XmArrowButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuA.sgm new file mode 100644 index 00000000..164b0674 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateBulletinBoard +library call + + +XmCreateBulletinBoard +The BulletinBoard widget creation function + +XmCreateBulletinBoard + +creation functions +XmCreateBulletinBoard + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/BulletinB.h> + +Widget XmCreateBulletinBoard + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateBulletinBoard creates an instance of a BulletinBoard +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of BulletinBoard and its associated resources, see +&cdeman.XmBulletinBoard;. + + + +RETURN +Returns the BulletinBoard widget ID. + + + +RELATED +&cdeman.XmBulletinBoard;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuB.sgm new file mode 100644 index 00000000..500dd627 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreBuB.sgm @@ -0,0 +1,121 @@ + + + + + + + + + + + +XmCreateBulletinBoardDialog +library call + + +XmCreateBulletinBoardDialog +The BulletinBoard BulletinBoardDialog convenience creation function + +XmCreateBulletinBoard\\%Dialog + +creation functions +XmCreateBulletinBoard\\%Dialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/BulletinB.h> + +Widget XmCreateBulletinBoardDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateBulletinBoardDialog is a convenience +creation function that creates a DialogShell and an unmanaged BulletinBoard +child of the DialogShell. +A BulletinBoardDialog is used for interactions not supported by the +standard dialog set. +This function does not automatically create +any labels, buttons, or other dialog components. Such components should be +added by the application after the BulletinBoardDialog is created. + +Use XtManageChild to pop up the BulletinBoardDialog (passing the +BulletinBoard as the widget parameter); use XtUnmanageChild to pop +it down. + +XmCreateBulletinBoardDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of BulletinBoard and its associated resources, see +&cdeman.XmBulletinBoard;. + + + +RETURN +Returns the BulletinBoard widget ID. + + + +RELATED +&cdeman.XmBulletinBoard;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaA.sgm new file mode 100644 index 00000000..568e35a2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateCascadeButton +library call + + +XmCreateCascadeButton +The CascadeButton widget creation function + +XmCreateCascadeButton + +creation functions +XmCreateCascadeButton + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CascadeB.h> + +Widget XmCreateCascadeButton + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateCascadeButton creates an instance of a CascadeButton +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID. The parent must be a RowColumn widget. + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of CascadeButton and its associated resources, see +&cdeman.XmCascadeButton;. + + + +RETURN +Returns the CascadeButton widget ID. + + + +RELATED +&cdeman.XmCascadeButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaB.sgm new file mode 100644 index 00000000..3f4a63c6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCaB.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmCreateCascadeButtonGadget +library call + + +XmCreateCascadeButtonGadget +The CascadeButtonGadget creation function + +XmCreateCascadeButton\\%Gadget + +creation functions +XmCreateCascadeButton\\%Gadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/CascadeBG.h> + +Widget XmCreateCascadeButtonGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateCascadeButtonGadget creates an instance of a +CascadeButtonGadget and returns the +associated widget ID. + + + +parent + +Specifies the parent widget ID. The parent must be a RowColumn widget. + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of CascadeButtonGadget and its +associated resources, see &cdeman.XmCascadeButtonGadget;. + + + +RETURN +Returns the CascadeButtonGadget widget ID. + + + +RELATED +&cdeman.XmCascadeButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoA.sgm new file mode 100644 index 00000000..d03590e2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoA.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmCreateComboBox +library call + + +XmCreateComboBox +The default ComboBox widget creation function + + + + + + + + + + + + + + +#include <Xm/ComboBox.h> + +Widget XmCreateComboBox + +Widget parent +String name +ArgList arglist +Cardinal arg_count + + + +DESCRIPTION +XmCreateComboBox creates an instance of a ComboBox widget of +XmNcomboBoxType XmCOMBO_BOX and returns +the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +arg_count + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of ComboBox and its associated resources, +see &cdeman.XmComboBox;. + + + +RETURN +Returns the ComboBox widget ID. + + + +RELATED +&cdeman.XmComboBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoB.sgm new file mode 100644 index 00000000..31c3b929 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoB.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmCreateCommand +library call + + +XmCreateCommand +The Command widget creation function + +XmCreateCommand + +creation functions +XmCreateCommand + + + + + + + + + + + +#include <Xm/Command.h> + +Widget XmCreateCommand + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateCommand creates an instance of a Command widget and returns the +associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RETURN +Returns the Command widget ID. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoC.sgm new file mode 100644 index 00000000..e9c8e0d2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCoC.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + + +XmCreateCommandDialog +library call + + +XmCreateCommandDialog +The Command CommandDialog convenience creation function + +XmCreateCommandDialog + +creation functions +XmCreateCommandDialog + + + + +#include <Xm/Command.h> + +Widget XmCreateCommandDialog +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateCommandDialog is a convenience function +that creates a DialogShell and an unmanaged Command child of the DialogShell. +A CommandDialog is used for entering commands for processing. + +Use XtManageChild to pop up the CommandDialog +(passing the Command as the widget parameter); +use XtUnmanageChild to pop it down. + +XmCreateCommandDialog forces the value of the +Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Command and its associated resources, see +&cdeman.XmCommand;. + + + +RETURN +Returns the Command widget ID. + + + +RELATED +&cdeman.XmCommand;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCon.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCon.sgm new file mode 100644 index 00000000..8495f968 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreCon.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmCreateContainer +library call + + +XmCreateContainer +The Container widget creation function + +XmCreateContainer + +creation functions +XmCreateContainer + + + + + + + + + + + + + + + +#include <Xm/Container.h> + +Widget XmCreateContainer + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateContainer creates an instance of a Container +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of Container and its associated resources, see +&cdeman.XmContainer;. + + + +RETURN +This function returns the Container widget ID. + + + +RELATED +&cdeman.XmContainer;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDia.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDia.sgm new file mode 100644 index 00000000..3d86e721 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDia.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateDialogShell +library call + + +XmCreateDialogShell +The DialogShell widget creation function + +XmCreateDialogShell + +creation functions +XmCreateDialogShell + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DialogS.h> + +Widget XmCreateDialogShell + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateDialogShell creates an instance of a DialogShell +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of DialogShell and its associated resources, see +&cdeman.XmDialogShell;. + + + +RETURN +Returns the DialogShell widget ID. + + + +RELATED +&cdeman.XmDialogShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrA.sgm new file mode 100644 index 00000000..a0297f30 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrA.sgm @@ -0,0 +1,116 @@ + + + + + + + + + + + +XmCreateDragIcon +library call + + +XmCreateDragIcon +A Drag and Drop function that creates a DragIcon widget + +XmCreateDragIcon + +Drag and Drop functions +XmCreateDragIcon + +creation functions +XmCreateDragIcon + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragIcon.h> + +Widget XmCreateDragIcon + +Widget widget +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateDragIcon creates a DragIcon and returns the associated widget +ID. + + + +widget + +Specifies the ID of the widget that the function uses to access +default values for visual attributes of the DragIcon. This widget +may be different than the actual parent of the DragIcon. + + + + +name + +Specifies the name of the DragIcon widget. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist). + + + + +For a complete definition of DragIcon and its associated resources, +see &cdeman.XmDragIcon;. + + + +RETURN +The function creates a DragIcon and returns the associated +widget ID. + + + +RELATED +&cdeman.XmDragContext;, +&cdeman.XmDragIcon;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrB.sgm new file mode 100644 index 00000000..262d9829 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateDrawingArea +library call + + +XmCreateDrawingArea +The DrawingArea widget creation function + +XmCreateDrawingArea + +creation functions +XmCreateDrawingArea + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DrawingA.h> + +Widget XmCreateDrawingArea + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateDrawingArea creates an instance of a DrawingArea widget and returns the +associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of DrawingArea and its associated resources, see +&cdeman.XmDrawingArea;. + + + +RETURN +Returns the DrawingArea widget ID. + + + +RELATED +&cdeman.XmDrawingArea;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrC.sgm new file mode 100644 index 00000000..39b4ee3e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrC.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateDrawnButton +library call + + +XmCreateDrawnButton +The DrawnButton widget creation function + +XmCreateDrawnButton + +creation functions +XmCreateDrawnButton + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DrawnB.h> + +Widget XmCreateDrawnButton + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateDrawnButton creates an instance of a DrawnButton widget and returns the +associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of DrawnButton and its associated resources, see +&cdeman.XmDrawnButton;. + + + +RETURN +Returns the DrawnButton widget ID. + + + +RELATED +&cdeman.XmDrawnButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrD.sgm new file mode 100644 index 00000000..015bd735 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrD.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmCreateDropDownComboBox +library call + + +XmCreateDropDownComboBox +The Drop-down ComboBox widget creation function + + + + + + + + + + + + + + +#include <Xm/ComboBox.h> + +Widget XmCreateDropDownComboBox + +Widget parent +String name +ArgList arglist +Cardinal arg_count + + + +DESCRIPTION +XmCreateDropDownComboBox creates an instance of a ComboBox widget of +XmNcomboBoxType XmDROP_DOWN_COMBO_BOX and returns +the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +arg_count + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of ComboBox and its associated resources, +see &cdeman.XmComboBox;. + + + +RETURN +Returns the ComboBox widget ID. + + + +RELATED +&cdeman.XmComboBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrE.sgm new file mode 100644 index 00000000..f99743a3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreDrE.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmCreateDropDownList +library call + + +XmCreateDropDownList +The Drop-down list ComboBox widget creation function + + + + + + + + + + + + + + + +#include <Xm/ComboBox.h> + +Widget XmCreateDropDownList + +Widget parent +String name +ArgList arglist +Cardinal arg_count + + + +DESCRIPTION +XmCreateDropDownList creates an instance of a ComboBox widget of +XmNcomboBoxType XmDROP_DOWN_LIST and returns +the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +arg_count + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of ComboBox and its associated resources, +see &cdeman.XmComboBox;. + + + +RETURN +Returns the ComboBox widget ID. + + + +RELATED +&cdeman.XmComboBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreErr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreErr.sgm new file mode 100644 index 00000000..2e64259d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreErr.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmCreateErrorDialog +library call + + +XmCreateErrorDialog +The MessageBox ErrorDialog convenience creation function + +XmCreateErrorDialog + +creation functions +XmCreateErrorDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateErrorDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateErrorDialog is a convenience creation +function that creates a DialogShell and an unmanaged MessageBox child +of the DialogShell. +An ErrorDialog warns the user of an invalid or potentially +dangerous condition. +It includes a symbol, a message, and three buttons. +The default symbol is an octagon with a diagonal slash. The default +button labels are OK, Cancel, and Help. + +Use XtManageChild to pop up the ErrorDialog (passing the MessageBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreateErrorDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiA.sgm new file mode 100644 index 00000000..4b331eb4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiA.sgm @@ -0,0 +1,142 @@ + + + + + + + + + + + +XmCreateFileSelectionBox +library call + + +XmCreateFileSelectionBox +The FileSelectionBox widget creation function + +XmCreateFileSelection\\%Box + +creation functions +XmCreateFileSelection\\%Box + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/FileSB.h> + +Widget XmCreateFileSelectionBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateFileSelectionBox creates an unmanaged FileSelectionBox. +A FileSelectionBox is used to select a file +and includes the following: + + + +An editable text field for the directory mask + + + +A scrolling list of filenames + + + +An editable text field for the selected file + + + +Labels for the list and text fields + + + +Four buttons + + + +The default button labels are OK, Filter, Cancel, and +Help. +Additional work area children may be added to the FileSelectionBox after +creation. FileSelectionBox inherits the layout functionality provided +by SelectionBox for any additional work area children. + +If the parent of the FileSelectionBox is a DialogShell, use XtManageChild +to pop up the FileSelectionDialog (passing the +FileSelectionBox as the widget parameter); +use XtUnmanageChild to pop it down. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of FileSelectionBox and its associated resources, see +&cdeman.XmFileSelectionBox;. + + + +RETURN +Returns the FileSelectionBox widget ID. + + + +RELATED +&cdeman.XmFileSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiB.sgm new file mode 100644 index 00000000..4dca0eca --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFiB.sgm @@ -0,0 +1,144 @@ + + + + + + + + + + + +XmCreateFileSelectionDialog +library call + + +XmCreateFileSelectionDialog +The FileSelectionBox FileSelectionDialog convenience creation function + +XmCreateFileSelection\\%Dialog + +creation functions +XmCreateFileSelection\\%Dialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/FileSB.h> + +Widget XmCreateFileSelectionDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateFileSelectionDialog is a convenience creation function that +creates a DialogShell and an unmanaged FileSelectionBox child of the +DialogShell. +A FileSelectionDialog selects a file. +It includes the following: + + + +An editable text field for the directory mask + + + +A scrolling list of filenames + + + +An editable text field for the selected file + + + +Labels for the list and text fields + + + +Four buttons + + + +The default button labels are +OK, Filter, Cancel, and Help. One additional +WorkArea child may be added to the FileSelectionBox after creation. + +Use XtManageChild to pop up the FileSelectionDialog (passing the +FileSelectionBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreateFileSelectionDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of FileSelectionBox and its associated resources, see +&cdeman.XmFileSelectionBox;. + + + +RETURN +Returns the FileSelectionBox widget ID. + + + +RELATED +&cdeman.XmFileSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoA.sgm new file mode 100644 index 00000000..5bb5fea2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateForm +library call + + +XmCreateForm +The Form widget creation function + +XmCreateForm + +creation functions +XmCreateForm + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Form.h> + +Widget XmCreateForm + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateForm creates an instance of a Form +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Form and its associated resources, see +&cdeman.XmForm;. + + + +RETURN +Returns the Form widget ID. + + + +RELATED +&cdeman.XmForm;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoB.sgm new file mode 100644 index 00000000..71cda692 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFoB.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmCreateFormDialog +library call + + +XmCreateFormDialog +A Form FormDialog convenience creation function + +XmCreateFormDialog + +creation functions +XmCreateFormDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Form.h> + +Widget XmCreateFormDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateFormDialog is a convenience creation function that creates +a DialogShell and an unmanaged Form child of the DialogShell. +A FormDialog is used for interactions not supported by the standard dialog +set. +This function +does not automatically create any labels, buttons, or other dialog components. +Such components should be added by the application after the FormDialog is +created. + +Use XtManageChild to pop up the FormDialog (passing the Form as the +widget parameter); use XtUnmanageChild to pop it down. + +XmCreateFormDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Form and its associated resources, see +&cdeman.XmForm;. + + + +RETURN +Returns the Form widget ID. + + + +RELATED +&cdeman.XmForm;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFra.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFra.sgm new file mode 100644 index 00000000..ec314245 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreFra.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateFrame +library call + + +XmCreateFrame +The Frame widget creation function + +XmCreateFrame + +creation functions +XmCreateFrame + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Frame.h> + +Widget XmCreateFrame + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateFrame creates an instance of a Frame +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Frame and its associated resources, see +&cdeman.XmFrame;. + + + +RETURN +Returns the Frame widget ID. + + + +RELATED +&cdeman.XmFrame;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreIco.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreIco.sgm new file mode 100644 index 00000000..a43e28d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreIco.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmCreateIconGadget +library call + + +XmCreateIconGadget +The IconGadget widget creation function + +XmCreateIconGadget + +creation functions +XmCreateIconGadget + + + + + + + + + + + +#include <Xm/IconG.h> + +Widget XmCreateIconGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateIconGadget creates an instance of an IconGadget +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of IconGadget and its associated resources, see +&cdeman.XmIconGadget;. + + + +RETURN +Returns the IconGadget widget ID. + + + +RELATED +&cdeman.XmIconGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreInf.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreInf.sgm new file mode 100644 index 00000000..b6d9b48a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreInf.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmCreateInformationDialog +library call + + +XmCreateInformationDialog +The MessageBox InformationDialog convenience creation function + +XmCreateInformationDialog + +creation functions +XmCreateInformationDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateInformationDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateInformationDialog is a convenience creation function that creates +a DialogShell and an unmanaged MessageBox child of the DialogShell. +An InformationDialog gives the user information, such as the status of +an action. +It includes a symbol, a message, and three buttons. +The default symbol is i. +The default button labels are OK, Cancel, and Help. + +Use XtManageChild to pop up the InformationDialog (passing the MessageBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreateInformationDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaA.sgm new file mode 100644 index 00000000..b90610fa --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateLabel +library call + + +XmCreateLabel +The Label widget creation function + +XmCreateLabel + +creation functions +XmCreateLabel + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Label.h> + +Widget XmCreateLabel + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateLabel creates an instance of a Label +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Label and its associated resources, see +&cdeman.XmLabel;. + + + +RETURN +Returns the Label widget ID. + + + +RELATED +&cdeman.XmLabel;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaB.sgm new file mode 100644 index 00000000..1aff4107 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLaB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateLabelGadget +library call + + +XmCreateLabelGadget +The LabelGadget creation function + +XmCreateLabelGadget + +creation functions +XmCreateLabelGadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/LabelG.h> + +Widget XmCreateLabelGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateLabelGadget creates an instance of a LabelGadget +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of LabelGadget and its associated resources, see +&cdeman.XmLabelGadget;. + + + +RETURN +Returns the LabelGadget widget ID. + + + +RELATED +&cdeman.XmLabelGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLis.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLis.sgm new file mode 100644 index 00000000..503608a3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreLis.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmCreateList +library call + + +XmCreateList +The List widget creation function + +XmCreateList + +creation functions +XmCreateList + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Widget XmCreateList + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateList creates an instance of a List widget and returns the associated +widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns the List widget ID. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMai.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMai.sgm new file mode 100644 index 00000000..ae12ac96 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMai.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateMainWindow +library call + + +XmCreateMainWindow +The MainWindow widget creation function + +XmCreateMainWindow + +creation functions +XmCreateMainWindow + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MainW.h> + +Widget XmCreateMainWindow + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateMainWindow creates an instance of a MainWindow +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MainWindow and its associated resources, see +&cdeman.XmMainWindow;. + + + +RETURN +Returns the MainWindow widget ID. + + + +RELATED +&cdeman.XmMainWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeA.sgm new file mode 100644 index 00000000..3b34cfee --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeA.sgm @@ -0,0 +1,141 @@ + + + + + + + + + + + +XmCreateMenuBar +library call + + +XmCreateMenuBar +A RowColumn widget convenience creation function + +XmCreateMenuBar + +creation functions +XmCreateMenuBar + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateMenuBar + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateMenuBar creates an instance of a RowColumn widget +of type XmMENU_BAR and returns the +associated widget ID. It is provided as a convenience +function for creating RowColumn +widgets configured to operate as a MenuBar and is not implemented as a +separate widget class. + +The MenuBar widget is generally used for building a Pulldown +menu system. Typically, a MenuBar is created and placed along the +top of the application window, and several CascadeButtons +are inserted as the children. Each of the CascadeButtons has a +Pulldown menu pane associated with it. +These Pulldown menu panes must have been created as children of the MenuBar. +The user interacts with the MenuBar by using either the mouse or +the keyboard. + +The MenuBar displays a 3-D shadow along its border. The application +controls the shadow attributes using the visual-related resources +supported by XmManager. + +The MenuBar widget is homogeneous in that it accepts only children +that are a subclass of XmCascadeButton or +XmCascadeButtonGadget. +Attempting to insert a child of a different class results in a warning +message. + +If the MenuBar does not have enough room to fit all of its subwidgets on a +single line, the MenuBar attempts to wrap the remaining entries onto +additional lines if allowed by the geometry manager of the parent widget. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCascadeButton;, +&cdeman.XmCascadeButtonGadget;, +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateSimpleMenuBar;, +&cdeman.XmManager;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleMenuBar;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeB.sgm new file mode 100644 index 00000000..297f1350 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateMenuShell +library call + + +XmCreateMenuShell +The MenuShell widget creation function + +XmCreateMenuShell + +creation functions +XmCreateMenuShell + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MenuShell.h> + +Widget XmCreateMenuShell + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateMenuShell creates an instance of a MenuShell +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MenuShell and its associated resources, see +&cdeman.XmMenuShell;. + + + +RETURN +Returns the MenuShell widget ID. + + + +RELATED +&cdeman.XmMenuShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeC.sgm new file mode 100644 index 00000000..b1e50764 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeC.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmCreateMessageBox +library call + + +XmCreateMessageBox +The MessageBox widget creation function + +XmCreateMessageBox + +creation functions +XmCreateMessageBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateMessageBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateMessageBox creates an unmanaged MessageBox. +A MessageBox is used for common interaction tasks, which include giving +information, asking questions, and reporting errors. +It includes an optional symbol, a message, and three buttons. + +By default, there is no symbol. The default button labels are OK, +Cancel, and Help. + +If the parent of the MessageBox is a DialogShell, use XtManageChild to +pop up the MessageBox (passing the MessageBox as the widget parameter); use +XtUnmanageChild to pop it down. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeD.sgm new file mode 100644 index 00000000..751c4bcc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreMeD.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmCreateMessageDialog +library call + + +XmCreateMessageDialog +The MessageBox MessageDialog convenience creation function + +XmCreateMessageDialog + +creation functions +XmCreateMessageDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateMessageDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateMessageDialog is a convenience creation function that creates +a DialogShell and an unmanaged MessageBox child of the DialogShell. +A MessageDialog is used for common interaction tasks, which include giving +information, asking questions, and reporting errors. +It includes a symbol, a message, and three buttons. +By default, there is no symbol. The default button labels are +OK, Cancel, and Help. + +Use XtManageChild to pop up the MessageDialog (passing the MessageBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreateMessageDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreNot.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreNot.sgm new file mode 100644 index 00000000..29115ab9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreNot.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmCreateNotebook +library call + + +XmCreateNotebook +The Notebook widget creation function + +XmCreateNotebook + +Notebook functions +XmCreateNotebook + + + + + + + + + + + + + + + +#include <Xm/Notebook.h> + +void XmCreateNotebook + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateNotebook creates an instance of a Notebook widget and +returns the associated widget ID. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + +For a complete definition of Notebook and its associated resources, see +&cdeman.XmNotebook;. + + + +RETURN +Returns the Notebook widget ID. + + + +RELATED +&cdeman.XmNotebook;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreOpt.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreOpt.sgm new file mode 100644 index 00000000..4520b388 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreOpt.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + + +XmCreateOptionMenu +library call + + +XmCreateOptionMenu +A RowColumn widget convenience creation function + +XmCreateOptionMenu + +creation functions +XmCreateOptionMenu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateOptionMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateOptionMenu creates an instance of a +RowColumn widget of type XmMENU_OPTION +and returns the associated widget ID. + +It is provided as a convenience function for creating a RowColumn +widget configured to operate as an OptionMenu and is not implemented as a +separate widget class. + +The OptionMenu widget is a specialized RowColumn manager composed of a +label, a selection area, and a +single Pulldown menu pane. When an application creates +an OptionMenu widget, it supplies the label string and the Pulldown menu pane. +In order for the operation to be successful, +there must be a valid XmNsubMenuId resource set +when this function is called. +The LabelGadget and the selection area (a CascadeButtonGadget) are created +by the OptionMenu. + +The OptionMenu's Pulldown menu pane must not contain any ToggleButtons or +ToggleButtonGadgets. +The results of including CascadeButtons or CascadeButtonGadgets in the +OptionMenu's Pulldown menu pane are undefined. + +An OptionMenu is laid out with the label displayed on one side of +the widget and the selection area on the other side when +XmNorientation is XmHORIZONTAL. +The layout of the label with respect to the selection area depends on +the XmNlayoutDirection resource in the horizontal orientation. +If the value is XmVERTICAL, +the label is above the selection area. +The selection area has a dual purpose; it displays the label of the last +item selected from the associated Pulldown menu pane, and it provides +the means for posting the Pulldown menu pane. + +The OptionMenu typically does not display any 3-D visuals around +itself or the internal LabelGadget. By default, the internal +CascadeButtonGadget has a visible 3-D shadow. +The application may change this +by getting the CascadeButtonGadget ID using XmOptionButtonGadget, and then +calling XtSetValues using the standard visual-related resources. + +The Pulldown menu pane is posted when the mouse pointer is moved over the +selection area and a mouse button that is defined by OptionMenu's +RowColumn parent is pressed. +The Pulldown menu pane is posted +and positioned so that the last selected item is directly over +the selection area. The mouse is then used to arm the desired menu +item. When the mouse button is released, the armed menu item is selected +and the label within the selection area is changed to match that of +the selected item. By default, BSelect is used to interact with an +OptionMenu. +The default can be changed with the RowColumn resource +XmNmenuPost. + +The OptionMenu also operates with the keyboard interface mechanism. +If the application has established a mnemonic with the OptionMenu, +pressing +Alt with the mnemonic causes the Pulldown menu pane to be posted with +traversal enabled. +The standard traversal keys can then be used to +move within the menu pane. Pressing +Return or typing a mnemonic or accelerator for one of the +menu items selects that item. + +An application may use the XmNmenuHistory resource to +indicate which item in the Pulldown menu pane should be treated as the current +choice and have its label displayed in the selection area. By default, +the first selectable item in the Pulldown menu pane is used. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. +These widgets (or gadgets) and the associated +OptionMenu areas are + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCascadeButtonGadget;, +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateSimpleOptionMenu;, +&cdeman.XmLabelGadget;, +&cdeman.XmOptionButtonGadget;, +&cdeman.XmOptionLabelGadget;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleOptionMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePan.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePan.sgm new file mode 100644 index 00000000..4ec73205 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePan.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreatePanedWindow +library call + + +XmCreatePanedWindow +The PanedWindow widget creation function + +XmCreatePanedWindow + +creation functions +XmCreatePanedWindow + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/PanedW.h> + +Widget XmCreatePanedWindow + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePanedWindow creates an instance of a PanedWindow +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of PanedWindow and its associated resources, see +&cdeman.XmPanedWindow;. + + + +RETURN +Returns the PanedWindow widget ID. + + + +RELATED +&cdeman.XmPanedWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePop.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePop.sgm new file mode 100644 index 00000000..7e9fad21 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePop.sgm @@ -0,0 +1,145 @@ + + + + + + + + + + + +XmCreatePopupMenu +library call + + +XmCreatePopupMenu +A RowColumn widget convenience creation function + +XmCreatePopupMenu + +creation functions +XmCreatePopupMenu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreatePopupMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePopupMenu creates an instance of a RowColumn widget +of type XmMENU_POPUP and returns +the associated widget ID. When this function is used to create the Popup +menu pane, a MenuShell widget is automatically created as the parent of +the menu pane. +The parent of the MenuShell widget is the widget indicated by the +parent parameter. + +XmCreatePopupMenu is +provided as a convenience function for creating RowColumn +widgets configured to operate as Popup menu panes and is not implemented as +a separate widget class. + +The PopupMenu is used as the first menu pane within a PopupMenu system; +all other +menu panes are of the Pulldown type. A Popup menu pane displays a +3-D shadow, unless the feature is disabled by the application. +The shadow appears around the edge of the menu pane. + +The Popup menu pane must be created as the child of a MenuShell widget in +order to function properly when it is incorporated into a menu. +If the application uses this convenience function for creating a +Popup menu pane, the MenuShell is automatically created as the real +parent of the menu pane. +If the application does not use this convenience function to create the +RowColumn to function as a Popup menu pane, +it is the application's responsibility to create the +MenuShell widget. + +To access the PopupMenu, the application must first position the +widget using the +XmMenuPosition function and then manage it using XtManageChild. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +Popup menu panes support tear-off capabilities +for tear-off menus through XmRowColumn +resources. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateSimplePopupMenu;, +&cdeman.XmMenuPosition;, +&cdeman.XmMenuShell;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimplePopupMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePro.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePro.sgm new file mode 100644 index 00000000..17e5d48a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePro.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmCreatePromptDialog +library call + + +XmCreatePromptDialog +The SelectionBox PromptDialog convenience creation function + +XmCreatePromptDialog + +creation functions +XmCreatePromptDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/SelectioB.h> + +Widget XmCreatePromptDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePromptDialog is a convenience creation function that creates +a DialogShell and an unmanaged SelectionBox child of the DialogShell. +A PromptDialog prompts the user for text input. +It includes a message, a text input region, and three managed buttons. +The default button labels are OK, Cancel, and Help. +An additional button, with Apply as the default label, is created +unmanaged; it may be explicitly managed if needed. One additional +WorkArea child may be added to the SelectionBox after creation. + +XmCreatePromptDialog forces the value of the SelectionBox resource +XmNdialogType to XmDIALOG_PROMPT. + +Use XtManageChild to pop up the PromptDialog (passing the SelectionBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreatePromptDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of SelectionBox and its associated resources, see +&cdeman.XmSelectionBox;. + + + +RETURN +Returns the SelectionBox widget ID. + + + +RELATED +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuA.sgm new file mode 100644 index 00000000..c358fec2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuA.sgm @@ -0,0 +1,179 @@ + + + + + + + + + + + +XmCreatePulldownMenu +library call + + +XmCreatePulldownMenu +A RowColumn widget convenience creation function + +XmCreatePulldownMenu + +creation functions +XmCreatePulldownMenu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreatePulldownMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePulldownMenu creates an instance of a +RowColumn widget of type XmMENU_PULLDOWN and returns +the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +Specifies the number of attribute/value pairs in the argument list +(arglist). +When this function is used to create the Pulldown +menu pane, a MenuShell widget is automatically created as the parent of the +menu pane. If the widget specified +by the parent parameter is a +Popup or a Pulldown menu pane, the MenuShell +widget is created as a child of the parent MenuShell; otherwise, it +is created as a child of the specified parent widget. + +XmCreatePulldownMenu is +provided as a convenience function for creating RowColumn +widgets configured to operate as Pulldown menu panes and is not implemented as +a separate widget class. + +A Pulldown menu pane displays a +3-D shadow, unless the feature is disabled by the application. +The shadow appears around the edge of the menu pane. + +A Pulldown menu pane is used with submenus that are to be +attached to a CascadeButton or a +CascadeButtonGadget. This is the case for all menu panes +that are part of a PulldownMenu system (a MenuBar), the menu pane +associated with an OptionMenu, and any menu panes that cascade from +a Popup menu pane. Pulldown menu panes that are to be associated with an +OptionMenu must be created before the OptionMenu is created. + +The Pulldown menu pane must be attached to a CascadeButton or CascadeButtonGadget +that resides in a MenuBar, a Popup menu pane, a Pulldown menu pane, or an +OptionMenu. It is attached with the button resource XmNsubMenuId. + +A MenuShell widget is required between the Pulldown menu pane and its +parent. +If the application uses this convenience function for creating a +Pulldown menu pane, the MenuShell is automatically created as the real +parent of the menu pane; otherwise, +it is the application's responsibility to create +the MenuShell widget. + +To function correctly when incorporated into a menu, the Pulldown menu pane's +hierarchy must be considered. This hierarchy depends on the +type of menu system that is being built, as follows: + + + +If the Pulldown menu pane is to be pulled down from a MenuBar, its parent +must be the MenuBar. + + + +If the Pulldown menu pane is to be pulled down from a Popup or another +Pulldown menu pane, its parent must be that Popup or Pulldown menu pane. + + + +If the Pulldown menu pane is to be pulled down from an OptionMenu, its +parent must be the same as the OptionMenu parent. + + + +PullDown menu panes support tear-off capabilities +for tear-off menus through XmRowColumn +resources. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCascadeButton;, +&cdeman.XmCascadeButtonGadget;, +&cdeman.XmCreateOptionMenu;, +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreateSimplePulldownMenu;, +&cdeman.XmMenuShell;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimplePulldownMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuB.sgm new file mode 100644 index 00000000..faa2a6f9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreatePushButton +library call + + +XmCreatePushButton +The PushButton widget creation function + +XmCreatePushButton + +creation functions +XmCreatePushButton + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/PushB.h> + +Widget XmCreatePushButton + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePushButton creates an instance of a PushButton +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of PushButton and its associated resources, see +&cdeman.XmPushButton;. + + + +RETURN +Returns the PushButton widget ID. + + + +RELATED +&cdeman.XmPushButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuC.sgm new file mode 100644 index 00000000..8593a69c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CrePuC.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreatePushButtonGadget +library call + + +XmCreatePushButtonGadget +The PushButtonGadget creation function + +XmCreatePushButtonGadget + +creation functions +XmCreatePushButtonGadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/PushBG.h> + +Widget XmCreatePushButtonGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreatePushButtonGadget creates an instance of a PushButtonGadget +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of PushButtonGadget and its associated +resources, see &cdeman.XmPushButtonGadget;. + + + +RETURN +Returns the PushButtonGadget widget ID. + + + +RELATED +&cdeman.XmPushButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreQue.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreQue.sgm new file mode 100644 index 00000000..1461e8d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreQue.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmCreateQuestionDialog +library call + + +XmCreateQuestionDialog +The MessageBox QuestionDialog convenience creation function + +XmCreateQuestionDialog + +creation functions +XmCreateQuestionDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateQuestionDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateQuestionDialog is a convenience creation function that +creates a DialogShell and an unmanaged MessageBox child of the DialogShell. +A QuestionDialog is used to get the answer to a question from the user. +It includes a symbol, a message, and +three buttons. The default symbol is a question mark. The default button +labels are OK, Cancel, and Help. + +Use XtManageChild to pop up the QuestionDialog (passing the MessageBox +as the widget parameter); use XtUnmanageChild to pop it down. + +XmCreateQuestionDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRad.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRad.sgm new file mode 100644 index 00000000..3bf1605a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRad.sgm @@ -0,0 +1,133 @@ + + + + + + + + + + + +XmCreateRadioBox +library call + + +XmCreateRadioBox +A RowColumn widget convenience creation function + +XmCreateRadioBox + +creation functions +XmCreateRadioBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateRadioBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateRadioBox creates an instance of a RowColumn widget +of type XmWORK_AREA and returns the +associated widget ID. Typically, +this is a composite widget that contains multiple +ToggleButtonGadgets. +The RadioBox arbitrates and ensures that at most one +ToggleButtonGadget is on at any time. + +Unless the application supplies other values in the arglist, this +function provides initial values for several RowColumn resources. +It initializes XmNpacking to XmPACK_COLUMN, +XmNradioBehavior to True, XmNisHomogeneous to True, and +XmNentryClass to XmToggleButtonGadgetClass. + +In a RadioBox, the ToggleButton or ToggleButtonGadget resource +XmNindicatorType defaults to XmONE_OF_MANY, and the +ToggleButton or ToggleButtonGadget resourceXmNvisibleWhenOff +defaults to True. + +This routine is provided as a convenience function for creating +RowColumn widgets. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmCreateWorkArea;, +&cdeman.XmRowColumn;, +&cdeman.XmVaCreateSimpleCheckBox;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRow.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRow.sgm new file mode 100644 index 00000000..760d701b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreRow.sgm @@ -0,0 +1,135 @@ + + + + + + + + + + + +XmCreateRowColumn +library call + + +XmCreateRowColumn +The RowColumn widget creation function + +XmCreateRowColumn + +creation functions +XmCreateRowColumn + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateRowColumn + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateRowColumn creates an instance of a +RowColumn widget and returns the associated widget ID. If +XmNrowColumnType is not specified, then it is created with +XmWORK_AREA, which is the default. + +If this function is used to create a Popup Menu of type +XmMENU_POPUP or a Pulldown Menu of type XmMENU_PULLDOWN, +a MenuShell widget is not automatically created as the parent of the +menu pane. The application must first create the MenuShell by using either +XmCreateMenuShell or the standard toolkit create function. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateMenuBar;, +&cdeman.XmCreateMenuShell;, +&cdeman.XmCreateOptionMenu;, +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleMenuBar;, +&cdeman.XmCreateSimpleOptionMenu;, +&cdeman.XmCreateSimplePopupMenu;, +&cdeman.XmCreateSimplePulldownMenu;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmCreateWorkArea;, +&cdeman.XmRowColumn;, +&cdeman.XmVaCreateSimpleCheckBox;, +&cdeman.XmVaCreateSimpleMenuBar;, +&cdeman.XmVaCreateSimpleOptionMenu;, +&cdeman.XmVaCreateSimplePopupMenu;, +&cdeman.XmVaCreateSimplePulldownMenu;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScA.sgm new file mode 100644 index 00000000..d270c9f3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateScale +library call + + +XmCreateScale +The Scale widget creation function + +XmCreateScale + +creation functions +XmCreateScale + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Scale.h> + +Widget XmCreateScale + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateScale creates an instance of a Scale widget and +returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Scale and its associated resources, see +&cdeman.XmScale;. + + + +RETURN +Returns the Scale widget ID. + + + +RELATED +&cdeman.XmScale;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScB.sgm new file mode 100644 index 00000000..758250ca --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateScrollBar +library call + + +XmCreateScrollBar +The ScrollBar widget creation function + +XmCreateScrollBar + +creation functions +XmCreateScrollBar + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrollBar.h> + +Widget XmCreateScrollBar + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateScrollBar creates an instance of a ScrollBar widget and +returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ScrollBar and its associated resources, see +&cdeman.XmScrollBar;. + + + +RETURN +Returns the ScrollBar widget ID. + + + +RELATED +&cdeman.XmScrollBar;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScD.sgm new file mode 100644 index 00000000..8a898cfb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScD.sgm @@ -0,0 +1,154 @@ + + + + + + + + + + + +XmCreateScrolledList +library call + + +XmCreateScrolledList +The List ScrolledList convenience creation function + +XmCreateScrolledList + +creation functions +XmCreateScrolledList + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Widget XmCreateScrolledList + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateScrolledList creates an instance of a List widget +that is contained within a ScrolledWindow. +The ScrolledWindow parent is created managed. +All ScrolledWindow subarea +widgets are automatically created by this function. +The ID returned by this function is that of the List widget +(not the ScrolledWindow widget). +Use this widget ID for all operations on the List widget. +Use the widget ID of the List widget's parent for all operations +on the ScrolledWindow. +To obtain the ID of the ScrolledWindow widget associated with the List widget, +use the Xt Intrinsics XtParent function. +The name of the ScrolledWindow +created by this function is formed by concatenating SW +onto the end of the name specified in the parameter list. + +All arguments to either the List or the ScrolledWindow widget can be +specified at creation time using this function. +Changes to initial position and size are sent only to the ScrolledWindow widget. +Other resources are sent to the List or the ScrolledWindow widget as appropriate. +Note that the result of providing the XmNdestroyCallback +resource in the creation arglist is unspecified. The +application should use the XtAddCallback function to add +callbacks to the appropriate widget (List or ScrolledWindow) after +creating it. + +This function forces the following initial values for ScrolledWindow +resources: + + + +XmNscrollingPolicy is set to XmAPPLICATION_DEFINED. + + + +XmNvisualPolicy is set to XmVARIABLE. + + + +XmNscrollBarDisplayPolicy is set to XmSTATIC. +(No initial value is forced for the List's +XmNscrollBarDisplayPolicy.) + + + +XmNshadowThickness is set to 0 (zero). + + + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns the List widget ID. + + + +RELATED +&cdeman.XmList; and &cdeman.XmScrolledWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScE.sgm new file mode 100644 index 00000000..7f400478 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScE.sgm @@ -0,0 +1,160 @@ + + + + + + + + + + + +XmCreateScrolledText +library call + + +XmCreateScrolledText +The Text ScrolledText convenience creation function + +XmCreateScrolledText + +creation functions +XmCreateScrolledText + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Widget XmCreateScrolledText + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateScrolledText creates an instance of a Text widget +that is contained within a ScrolledWindow. +The ScrolledWindow parent is created managed. +All ScrolledWindow subarea +widgets are automatically created by this function. +The ID returned by this function is that of the Text widget +(not the ScrolledWindow widget). +Use this widget ID for all operations on the Text widget. +Use the widget ID of the Text widget's parent for +all operations on the ScrolledWindow. +To obtain the ID of the ScrolledWindow widget associated with the +Text widget, use the Xt Intrinsics XtParent function. +The name of the ScrolledWindow created by this function is formed by +concatenating the letters SW +onto the end of the name specified in the parameter list. + +The Text widget defaults to single-line text edit; therefore, no ScrollBars +are displayed. The Text resource XmNeditMode must be set to +XmMULTI_LINE_EDIT to display the ScrollBars. +The results of placing a Text widget inside a ScrolledWindow when the +Text's XmNeditMode is XmSINGLE_LINE_EDIT are undefined. + +All arguments to either the Text or the ScrolledWindow widget can be +specified at creation time with this function. +Changes to initial position and size are sent only to the ScrolledWindow +widget. +Other resources are sent to the Text or the ScrolledWindow widget as +appropriate. +Note that the result of providing the XmNdestroyCallback +resource in the creation arglist is unspecified. The +application should use the XtAddCallback function to add +callbacks to the appropriate widget (Text or ScrolledWindow) after +creating it. + +This function forces the following initial values for ScrolledWindow +resources: + + + +XmNscrollingPolicy is set to XmAPPLICATION_DEFINED. + + + +XmNvisualPolicy is set to XmVARIABLE. + + + +XmNscrollBarDisplayPolicy is set to XmSTATIC. + + + +XmNshadowThickness is set to 0 (zero). + + + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the Text widget ID. + + + +RELATED +&cdeman.XmScrolledWindow; and &cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScF.sgm new file mode 100644 index 00000000..db377a71 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreScF.sgm @@ -0,0 +1,106 @@ + + + + + + + + + + + +XmCreateScrolledWindow +library call + + +XmCreateScrolledWindow +The ScrolledWindow widget creation function + +XmCreateScrolledWindow + +creation functions +XmCreateScrolledWindow + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrolledW.h> + +Widget XmCreateScrolledWindow + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateScrolledWindow creates an instance of a ScrolledWindow +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ScrolledWindow and its associated resources, see +&cdeman.XmScrolledWindow;. + + + +RETURN +Returns the ScrolledWindow widget ID. + + + +RELATED +&cdeman.XmScrolledWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeA.sgm new file mode 100644 index 00000000..3218543b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeA.sgm @@ -0,0 +1,134 @@ + + + + + + + + + + + +XmCreateSelectionBox +library call + + +XmCreateSelectionBox +The SelectionBox widget creation function + +XmCreateSelectionBox + +creation functions +XmCreateSelectionBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/SelectioB.h> + +Widget XmCreateSelectionBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSelectionBox creates an unmanaged SelectionBox. +A SelectionBox is used to get a selection +from a list of alternatives from the user and +includes the following: + + + +A scrolling list of alternatives + + + +An editable text field for the selected alternative + + + +Labels for the list and text field + + + +Three or four buttons + + + +The default button labels are OK, Cancel, and Help. +By default, an Apply button is also created. If the parent of the +SelectionBox is a DialogShell, it is managed; otherwise it is unmanaged. +Additional work area children may be added to the SelectionBox after +creation. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of SelectionBox +and its associated resources, see &cdeman.XmSelectionBox;. + + + +RETURN +Returns the SelectionBox widget ID. + + + +RELATED +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeB.sgm new file mode 100644 index 00000000..69bb52f1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeB.sgm @@ -0,0 +1,144 @@ + + + + + + + + + + + +XmCreateSelectionDialog +library call + + +XmCreateSelectionDialog +The SelectionBox SelectionDialog convenience creation function + +XmCreateSelectionDialog + +creation functions +XmCreateSelectionDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/SelectioB.h> + +Widget XmCreateSelectionDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSelectionDialog is a convenience creation function that creates +a DialogShell and an unmanaged SelectionBox child of the DialogShell. +A SelectionDialog offers the user a choice from a list of alternatives +and gets a selection. +It includes the following: + + + +A scrolling list of alternatives + + + +An editable text field for the selected alternative + + + +Labels for the text field + + + +Four buttons + + + +The default button labels are OK, Cancel, Apply, +and Help. +One additional WorkArea child may be added to the +SelectionBox after creation. + +XmCreateSelectionDialog forces the value of the SelectionBox resource +XmNdialogType to XmDIALOG_SELECTION. + +XmCreateSelectionDialog forces the value of the Shell resource +XmNallowShellResize to True. + +Use XtManageChild to pop up the SelectionDialog (passing the +SelectionBox as the widget parameter); +use XtUnmanageChild to pop it down. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of SelectionBox and its associated resources, see +&cdeman.XmSelectionBox;. + + + +RETURN +Returns the SelectionBox widget ID. + + + +RELATED +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeC.sgm new file mode 100644 index 00000000..d5289f09 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeC.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateSeparator +library call + + +XmCreateSeparator +The Separator widget creation function + +XmCreateSeparator + +creation functions +XmCreateSeparator + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Separator.h> + +Widget XmCreateSeparator + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSeparator creates an instance of a Separator +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Separator and its associated resources, see +&cdeman.XmSeparator;. + + + +RETURN +Returns the Separator widget ID. + + + +RELATED +&cdeman.XmSeparator;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeD.sgm new file mode 100644 index 00000000..19ca98a8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSeD.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateSeparatorGadget +library call + + +XmCreateSeparatorGadget +The SeparatorGadget creation function + +XmCreateSeparatorGadget + +creation functions +XmCreateSeparatorGadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/SeparatoG.h> + +Widget XmCreateSeparatorGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSeparatorGadget creates an instance of a SeparatorGadget +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of SeparatorGadget and its associated resources, see +&cdeman.XmSeparatorGadget;. + + + +RETURN +Returns the SeparatorGadget widget ID. + + + +RELATED +&cdeman.XmSeparatorGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiA.sgm new file mode 100644 index 00000000..78329ebd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiA.sgm @@ -0,0 +1,126 @@ + + + + + + + + + + + +XmCreateSimpleCheckBox +library call + + +XmCreateSimpleCheckBox +A RowColumn widget convenience creation function + +XmCreateSimpleCheckBox + +creation functions +XmCreateSimpleCheckBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimpleCheckBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimpleCheckBox creates an instance of a RowColumn widget +of type XmWORK_AREA and returns the associated widget ID. + +This routine creates a CheckBox and its ToggleButtonGadget children. +A CheckBox is similar to a RadioBox, except that more than one button +can be selected at a time. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +Buttons are named and created in the order they are specified +in the RowColumn simple menu creation resources supplied in the argument +list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button type allowed in the XmNbuttonType resource is +XmCHECKBUTTON. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmRowColumn;, +&cdeman.XmVaCreateSimpleCheckBox;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiB.sgm new file mode 100644 index 00000000..e6ac975b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiB.sgm @@ -0,0 +1,122 @@ + + + + + + + + + + + +XmCreateSimpleMenuBar +library call + + +XmCreateSimpleMenuBar +A RowColumn widget convenience creation function + +XmCreateSimpleMenuBar + +creation functions +XmCreateSimpleMenuBar + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimpleMenuBar + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimpleMenuBar creates an instance of a RowColumn widget of +type XmMENU_BAR and returns the associated widget ID. + +This routine creates a MenuBar and its CascadeButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +Buttons are named and created in the order they are specified +in the RowColumn simple menu creation resources supplied in the argument +list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button type allowed in the XmNbuttonType resource is +XmCASCADEBUTTON. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateMenuBar;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleMenuBar;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiC.sgm new file mode 100644 index 00000000..de18c5ec --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiC.sgm @@ -0,0 +1,147 @@ + + + + + + + + + + + +XmCreateSimpleOptionMenu +library call + + +XmCreateSimpleOptionMenu +A RowColumn widget convenience creation function + +XmCreateSimpleOptionMenu + +creation functions +XmCreateSimpleOptionMenu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimpleOptionMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimpleOptionMenu creates an instance of a RowColumn widget +of type XmMENU_OPTION and returns the associated widget ID. + +This routine creates an OptionMenu and its submenu containing +PushButtonGadget or CascadeButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an integer +from 0 (zero) to the number of separators in the menu minus 1. +Buttons and separators are named and created in the order they +are specified in the RowColumn simple menu creation resources supplied +in the argument list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. +These widgets (or gadgets) and the associated +OptionMenu areas are + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button types allowed in the XmNbuttonType resource are +XmPUSHBUTTON, XmCASCADEBUTTON, XmSEPARATOR, and +XmDOUBLE_SEPARATOR. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateOptionMenu;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleOptionMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiD.sgm new file mode 100644 index 00000000..2c393abc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiD.sgm @@ -0,0 +1,128 @@ + + + + + + + + + + + +XmCreateSimplePopupMenu +library call + + +XmCreateSimplePopupMenu +A RowColumn widget convenience creation function + +XmCreateSimplePopupMenu + +creation functions +XmCreateSimplePopupMenu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimplePopupMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimplePopupMenu creates an instance of a RowColumn widget +of type XmMENU_POPUP and returns the associated widget ID. + +This routine creates a Popup menu pane and its button children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an integer +from 0 (zero) to the number of separators in the menu minus 1. +The name of each title is label_n, where n is an integer +from 0 (zero) to the number of titles in the menu minus 1. +Buttons, separators, and titles are named and created in the order in +which they are specified in the RowColumn simple menu creation resources +supplied in the argument list. + + + +parent + +Specifies the widget ID of the parent of the MenuShell + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button types allowed in the XmNbuttonType resource are +XmCASCADEBUTTON, XmPUSHBUTTON, XmRADIOBUTTON, +XmCHECKBUTTON, XmTITLE, XmSEPARATOR, and +XmDOUBLE_SEPARATOR. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimplePopupMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiE.sgm new file mode 100644 index 00000000..ab7d27f8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiE.sgm @@ -0,0 +1,130 @@ + + + + + + + + + + + +XmCreateSimplePulldownMenu +library call + + +XmCreateSimplePulldownMenu +A RowColumn widget convenience creation function + +XmCreateSimplePulldown\\%Menu + +creation functions +XmCreateSimplePulldown\\%Menu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimplePulldownMenu + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimplePulldownMenu creates an instance of a RowColumn +widget of type XmMENU_PULLDOWN and returns the associated widget +ID. + +This routine creates a Pulldown menu pane and its button children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an integer +from 0 (zero) to +the number of separators in the menu minus 1. +The name of each title is label_n, where n is an +integer from 0 (zero) to the number of titles in the menu minus 1. +Buttons, separators, and titles are named and created in the order +they are specified in the RowColumn simple menu creation resources +supplied in the argument list. + + + +parent + +Specifies the widget ID of the parent of the MenuShell + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button types allowed in the XmNbuttonType resource are +XmCASCADEBUTTON, XmPUSHBUTTON, XmRADIOBUTTON, +XmCHECKBUTTON, XmTITLE, XmSEPARATOR, and +XmDOUBLE_SEPARATOR. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimplePulldownMenu;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiF.sgm new file mode 100644 index 00000000..bad7b1cd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSiF.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmCreateSimpleRadioBox +library call + + +XmCreateSimpleRadioBox +A RowColumn widget convenience creation function + +XmCreateSimpleRadioBox + +creation functions +XmCreateSimpleRadioBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateSimpleRadioBox + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateSimpleRadioBox creates an instance of a RowColumn widget +of type XmWORK_AREA and returns the associated widget ID. + +This routine creates a RadioBox and its ToggleButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +Buttons are named and created in the order they are specified +in the RowColumn simple menu creation resources supplied in the argument +list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +A number of resources exist specifically for use with this and +other simple menu creation routines. +The only button type allowed in the XmNbuttonType resource is +XmRADIOBUTTON. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpi.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpi.sgm new file mode 100644 index 00000000..07d6fc96 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpi.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmCreateSpinBox +library call + + +XmCreateSpinBox +The SpinBox creation function + +XmCreateSpinBox + +creation functions +XmCreateSpinBox + + + + + + + + + + + + + + + + +#include <Xm/SpinB.h> + + + + + + +DESCRIPTION +XmCreateSpinBox creates a SpinBox widget. + +This function creates a SpinBox with two arrows, +but without any traversable children (choices to spin). +The application can create text children to go with this parent SpinBox +using XmCreateTextField or +XmCreateText. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of SpinBox and its associated resources, see +&cdeman.XmSpinBox;. + + + +RETURN +Returns the SpinBox widget ID. + + + +RELATED +&cdeman.XmSpinBox; + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpinB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpinB.sgm new file mode 100644 index 00000000..4975bc65 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreSpinB.sgm @@ -0,0 +1,71 @@ + + + + + + + + + + +XmCreateSimpleSpinBox +library call + + +XmCreateSimpleSpinBox +the SimpleSpinBox widget creation function + + + + + + + + + + +#include <Xm/SSpinB.h> + +Widget XmCreateSimpleSpinBox +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +The +XmCreateSimpleSpinBox function creates an instance of a SpinBox +widget and returns the associated widget ID. + +The +parent argument specifies the parent widget ID. + +The +name argument specifies the name of the created widget. + +The +arglist argument specifies the argument list. + +The +argcount argument specifies the number of attribute/value pairs in the argument list. + + + +RETURN VALUE +Upon successful completion, the +XmCreateSimpleSpinBox function returns the SimpleSpinBox widget ID. + + + +SEE ALSO +&cdeman.XmSimpleSpinBox;. +]]> +XmSimpleSpinBox. +]]> + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeA.sgm new file mode 100644 index 00000000..ce34f149 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeA.sgm @@ -0,0 +1,126 @@ + + + + + + + + + + + +XmCreateTemplateDialog +library call + + +XmCreateTemplateDialog +A MessageBox TemplateDialog convenience +creation function + +XmCreateTemplateDialog + +create functions +XmCreateTemplateDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateTemplateDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateTemplateDialog is a convenience creation function +that creates a DialogShell and an unmanaged MessageBox child of +the DialogShell. The MessageBox widget's XmNdialogType resource +is set to XmDIALOG_TEMPLATE. By default, the TemplateDialog +widget contains only the separator child. You can build +a customized dialog by adding children to the TemplateDialog. + +You can create +the standard MessageBox pushbuttons, Cancel, Help, +and OK, by specifying the associated callback +and label string resources. Setting XmNsymbolPixmap +or XmNmessageString creates a symbol or message label. + +Use XtManageChild to pop up the TemplateDialog (passing the +MessageBox as the widget parameter); use XtUnmanageChild to +pop it down. + +XmCreateTemplateDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist) + + + + +For a complete definition of MessageBox and its associated resources, +see &cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeB.sgm new file mode 100644 index 00000000..c1716691 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateText +library call + + +XmCreateText +The Text widget creation function + +XmCreateText + +creation functions +XmCreateText + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Widget XmCreateText + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateText creates an instance of a Text +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the Text widget ID. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeC.sgm new file mode 100644 index 00000000..92293fc7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreTeC.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateTextField +library call + + +XmCreateTextField +The TextField widget creation function + +XmCreateTextField + +creation functions +XmCreateTextField + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Widget XmCreateTextField + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateTextField creates an instance of a TextField +widget and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns the TextField widget ID. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToA.sgm new file mode 100644 index 00000000..859b1cd7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToA.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateToggleButton +library call + + +XmCreateToggleButton +The ToggleButton widget creation function + +XmCreateToggleButton + +creation functions +XmCreateToggleButton + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleB.h> + +Widget XmCreateToggleButton + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateToggleButton creates an instance of a ToggleButton widget and +returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ToggleButton and its associated resources, see +&cdeman.XmToggleButton;. + + + +RETURN +Returns the ToggleButton widget ID. + + + +RELATED +&cdeman.XmToggleButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToB.sgm new file mode 100644 index 00000000..125b68e7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreToB.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmCreateToggleButtonGadget +library call + + +XmCreateToggleButtonGadget +The ToggleButtonGadget creation function + +XmCreateToggleButton\\%Gadget + +creation functions +XmCreateToggleButton\\%Gadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleBG.h> + +Widget XmCreateToggleButtonGadget + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateToggleButtonGadget creates an instance of a ToggleButtonGadget +and returns the associated widget ID. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of ToggleButtonGadget and +its associated resources, see &cdeman.XmToggleButtonGadget;. + + + +RETURN +Returns the ToggleButtonGadget widget ID. + + + +RELATED +&cdeman.XmToggleButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWar.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWar.sgm new file mode 100644 index 00000000..8a2d268a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWar.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmCreateWarningDialog +library call + + +XmCreateWarningDialog +The MessageBox WarningDialog convenience creation function + +XmCreateWarningDialog + +creation functions +XmCreateWarningDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateWarningDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateWarningDialog is a convenience creation function that +creates a DialogShell and an unmanaged MessageBox child of the DialogShell. +A WarningDialog warns users of action consequences and gives them +a choice of resolutions. +It includes a symbol, a message, and three buttons. +The default symbol is an exclamation point. The default button labels are +OK, Cancel, and Help. + +Use XtManageChild to pop up the WarningDialog (passing the +MessageBox as the widget parameter); +use XtUnmanageChild to pop it down. + +XmCreateWarningDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoA.sgm new file mode 100644 index 00000000..ebb9972a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoA.sgm @@ -0,0 +1,115 @@ + + + + + + + + + + + +XmCreateWorkArea +library call + + +XmCreateWorkArea +A function that creates a RowColumn WorkArea + +XmCreateWorkArea + +creation functions +XmCreateWorkArea + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmCreateWorkArea + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateWorkArea creates an instance of a +RowColumn widget and returns the associated widget ID. +The widget is created with XmNrowColumnType set to +XmWORK_AREA. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmRowColumn;, +&cdeman.XmVaCreateSimpleCheckBox;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoB.sgm new file mode 100644 index 00000000..40bca27b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CreWoB.sgm @@ -0,0 +1,121 @@ + + + + + + + + + + + +XmCreateWorkingDialog +library call + + +XmCreateWorkingDialog +The MessageBox WorkingDialog convenience creation function + +XmCreateWorkingDialog + +creation functions +XmCreateWorkingDialog + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmCreateWorkingDialog + +Widget parent +String name +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmCreateWorkingDialog is a convenience creation function that +creates a DialogShell and an unmanaged MessageBox child of the DialogShell. +A WorkingDialog informs users that there is a time-consuming +operation in progress and allows them to cancel the +operation. +It includes a symbol, a message, and three buttons. +The default symbol is an hourglass. The default button labels are +OK, Cancel, and Help. + +Use XtManageChild to pop up the WorkingDialog (passing the +MessageBox as the widget parameter); +use XtUnmanageChild to pop it down. + +XmCreateWorkingDialog forces the value of the Shell resource +XmNallowShellResize to True. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the MessageBox widget ID. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtByteS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtByteS.sgm new file mode 100644 index 00000000..39e5bbf9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtByteS.sgm @@ -0,0 +1,75 @@ + + + + + + + + + + + +XmCvtByteStreamToXmString +library call + + +XmCvtByteStreamToXmString +A compound string function that converts from a compound string in Byte Stream format to a compound string + +XmCvtByteStreamToXmString + +compound string functions +XmCvtByteStreamToXmString + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmCvtByteStreamToXmString + +unsigned char *property + + + +DESCRIPTION +XmCvtByteStreamToXmString converts a stream of bytes representing a +compound string in Byte Stream format to a compound string. +This routine is typically used by the destination of a data transfer +operation to produce a compound string from a transferred Byte Stream +representation. + + + +property + +Specifies a compound string representation in Byte Stream format. + + + + + + +RETURN +Returns a compound string. +The function allocates space to hold the returned compound string. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XmStringFree. + + + +RELATED +&cdeman.XmString;, +&cdeman.XmCvtXmStringToByteStream;, and +&cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtCTTXm.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtCTTXm.sgm new file mode 100644 index 00000000..f26d993b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtCTTXm.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmCvtCTToXmString +library call + + +XmCvtCTToXmString +A compound string function that converts compound text to a compound string + +XmCvtCTToXmString + +compound string functions +XmCvtCTToXmString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmCvtCTToXmString + +char * text + + + +DESCRIPTION +XmCvtCTToXmString converts a (char *) string in compound text +format to a compound string. +The application must call XtAppInitialize before calling this +function. +Conversion of compound text to compound strings is implementation +dependent. + + + +text + +Specifies a string in compound text format to be converted to a compound +string. + + + + + + +RETURN +Returns a compound string derived from the compound text. +The function allocates space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. +The compound text is assumed to be NULL-terminated; NULLs within the +compound text are handled correctly. +The handling of HORIZONTAL TABULATION (HT) control characters within the +compound text is undefined. +The compound text format is described in the X Consortium Standard +Compound Text Encoding. + + + +RELATED +&cdeman.XmCvtXmStringToCT;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtSt.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtSt.sgm new file mode 100644 index 00000000..3037a725 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtSt.sgm @@ -0,0 +1,191 @@ + + + + + + + + + + + +XmConvertStringToUnits +library call + + +XmConvertStringToUnits +A function that converts a string specification to a unit value + +XmConvertStringToUnits + + + + + + + + + + + +#include <Xm/Xm.h> + +int XmConvertStringToUnits + +Screen *screen +String spec +int orientation +int to_type +XtEnum *parse_error + + + +DESCRIPTION +XmConvertStringToUnits converts a string specification value and +returns the converted value as the return value from the function. +This function uses the specified screen's resolution to compute the +number of units for the string specification. + + + +screen + +Specifies the screen whose resolution is to be used for the computation. + + + + +spec + +Specifies the string, in <floating value><unit> format, to be +converted. + + + + +orientation + +Specifies whether the converter uses the horizontal or vertical screen +resolution when performing the conversion. The orientation +parameter can have values of XmHORIZONTAL or XmVERTICAL. + + + + +to_type + +Converts the value to the unit type specified. +Refer to the XmNunitType resource of the +XmGadget, XmManager, or XmPrimitive reference page. +This parameter can have one of +the following values: + + + +XmPIXELS + +The returned value will be the number of pixels. + + + + +XmMILLIMETERS + +The returned value will be the number of millimeters. + + + + +Xm100TH_MILLIMETERS + +The returned values will be the number of 1/100 millimeters. + + + + +XmCENTIMETERS + +The returned values will be the number of centimeters. + + + + +XmINCHES + +The returned values will be the number of inches. + + + + +Xm1000TH_INCHES + +The returned values will be the number of 1/100 inches. + + + + +XmPOINTS + +The returned values will be the number of points. +A point is a text processing unit +defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +The returned values will be the number of 1/100 points. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are +treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + + + + +parse_error + +Specifies if a parsing error occurred. This is set to a value of True +indicates that an error occurred, a value of False to indicate no error. + + + + + + +RETURN +Returns the converted value. +If a NULL screen, incorrect orientation, +or incorrect unit_type +is supplied as parameter data, or if a parsing error occurred, 0 +(zero) is returned. + + + +RELATED +&cdeman.XmConvertUnits;, &cdeman.XmSetFontUnits;, and &cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtStr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtStr.sgm new file mode 100644 index 00000000..f8b19f10 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtStr.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmCvtStringToUnitType +library call + + +XmCvtStringToUnitType +A function that converts a string to a unit-type value + +XmCvtStringToUnitType + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmCvtStringToUnitType + +XrmValuePtr args +Cardinal * num_args +XrmValue * from_val +XrmValue * to_val + + + +DESCRIPTION +XmCvtStringToUnitType converts a string to a unit type. Refer to +the reference pages for XmGadget, +XmManager, or XmPrimitive for a +description of the valid unit types. +Use of this function as a resource converter is obsolete. It has been replaced +by a new resource converter that uses the RepType facility. + + + +args + +Specifies a list of additional XrmValue arguments to the converter +if additional context is needed to perform the conversion. For example, +the string-to-font converter needs the widget's screen and the +string-to-pixel converter needs the widget's screen and color map. This +argument is often NULL. + + + + +num_args + +Specifies the number of additional XrmValue arguments. This argument +is often zero. + + + + +from_val + +Specifies the value to convert + + + + +to_val + +Specifies the descriptor to use to return the converted value + + + + + + +RELATED +&cdeman.XmGadget;, &cdeman.XmManager;, and &cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtTxtPr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtTxtPr.sgm new file mode 100644 index 00000000..bf1be6b7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtTxtPr.sgm @@ -0,0 +1,165 @@ + + + + + + + + + + + +XmCvtTextPropertyToXmStringTable +library call + + +XmCvtTextPropertyToXmStringTable +A function that converts from a TextProperty Structure to a StringTable + +XmCvtTextPropertyToXmStringTable + + + + + + + + + + + + +#include <Xm/Xm.h> +int XmCvtTextPropertyToXmStringTable (display, text_prop, string_table_return, count_return) + Display *display; + XTextProperty *text_prop; + XmStringTable *string_table_return; + int *count_return; + + + + + + +DESCRIPTION +XmCvtTextPropertyToXmStringTable converts the specified +XTextProperty structure into an XmStringTable, as follows: + + + +If the encoding member of text_prop is the Atom STRING, each +returned XmString +has a tag of "ISO8859-1" and a text type of XmCHARSET_TEXT. + + + +If +the encoding member of text_prop is the encoding of the current locale, +and if that encoding is not STRING, each returned XmString has a +tag of _MOTIF_DEFAULT_LOCALE and a text type of +XmMULTIBYTE_TEXT. + + + +If +the encoding member of text_prop is other than STRING or +the encoding of the current locale, +the contents of the returned compound strings are +implementation dependent. + + + +If conversion depends on the +locale and the current locale is not supported, the function returns +XLocaleNotSupported. If conversion to the encoding of the current +locale is required and if the locale is supported but no converter is +available for the encoding specified in text_prop, the function +returns XConverterNotFound. For supported locales, existence of +a converter +from COMPOUND_TEXT, STRING, or the encoding of the current +locale is +guaranteed if XSupportsLocale returns True for the current locale (but +the actual text may contain unconvertible characters). Conversion of +other encodings to the encoding of the current locale is implementation +dependent. In all of these error cases, the function does not set any +return values. + +If an element of the value member of text_prop is not +convertible to XmString, the corresponding entry in the returned +XmStringTable will be NULL, and +XmCvtTextPropertyToXmStringTable returns Success. + +To free the storage for the XmStringTable and its +count_return compound strings returned by this function, first +free each XmString in the table using XmStringFree, and +then free the XmStringTable itself using XtFree. + + + +display + +Specifies the connection to the X server. + + + + +text_prop + +Specifies a pointer to the XTextProperty. +The format member of text_prop must be 8. + + + + +string_table_return + +Specifies the XmStringTable array into which the converted compound +strings are placed. + + + + +count_return + +Specifies the number of XmStrings returned by this function. + + + + + + +RETURN VALUES +Upon success, this function returns the set of XmStrings in +string_table_return, and it returns the number of XmStrings in +count_return, and returns Success. Otherwise, it returns the +following: + + + +XLocaleNotSupported + +Returned if conversion depends on the +locale and the current locale is not supported. + + + + +XConverterNotFound + +Returned if conversion to the encoding of the current +locale is required and if the locale is supported but no converter is +available for the encoding specified in text_prop. + + + + + + +RELATED INFORMATION +&cdeman.XmCvtXmStringTableToTextProperty;, +&cdeman.XmText;, and +&cdeman.XmTextGetString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtUn.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtUn.sgm new file mode 100644 index 00000000..aec39d78 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtUn.sgm @@ -0,0 +1,214 @@ + + + + + + + + + + + +XmConvertUnits +library call + + +XmConvertUnits +A function that converts a value in one unit type to another unit type + +XmConvertUnits + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +int XmConvertUnits + +Widget widget +int orientation +int from_unit_type +int from_value +int to_unit_type + + + +DESCRIPTION +XmConvertUnits converts the value and returns it as the return value from +the function. +For resources of type, dimension, or position, you can specify units +using the syntax described in the XmNunitType resource of the +XmPrimitive reference page. + + + +widget + +Specifies the widget for which the data is to be converted. + + + + +orientation + +Specifies whether the converter uses the horizontal or vertical screen +resolution when performing the conversions. The orientation +parameter can have values of +XmHORIZONTAL or XmVERTICAL. + + + + +from_unit_type + +Specifies the current unit type of the supplied value + + + + +from_value + +Specifies the value to be converted + + + + +to_unit_type + +Converts the value to the unit type specified + + + + +The parameters from_unit_type and to_unit_type can have the +following values: + + + +XmPIXELS + +All values provided to the widget are treated as +pixel values. This +is the default for the resource. + + + + +XmMILLIMETERS + +All values provided to the widget are treated as millimeter +values. + + + + +Xm100TH_MILLIMETERS + +All values provided to the widget are +treated as 1/100 of a millimeter. + + + + +XmCENTIMETERS + +All values provided to the widget are treated as centimeter +values. + + + + +XmINCHES + +All values provided to the widget are treated as inch +values. + + + + +Xm1000TH_INCHES + +All values provided to the widget are treated +as 1/1000 of an inch. + + + + +XmPOINTS + +All values provided to the widget are treated as point +values. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +All values provided to the widget are treated as +1/100 of a point. +A point is a unit typically used in text processing applications and +is defined as 1/72 of an inch. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as normal font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are +treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + + + +RETURN +Returns the converted value. +If a NULL widget, incorrect orientation, or incorrect unit_type +is supplied as parameter data, 0 (zero) is returned. + + + +RELATED +XmPrimitive, +&cdeman.XmSetFontUnits;, +and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStA.sgm new file mode 100644 index 00000000..bae559ef --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStA.sgm @@ -0,0 +1,178 @@ + + + + + + + + + + + +XmCvtXmStringTableToTextProperty +library call + + +XmCvtXmStringTableToTextProperty +A function that converts from XmStringTable to an XTextProperty Structure + +XmCvtXmStringTableToTextProperty + + + + + + + + + + + +#include <Xm/Xm.h> +int XmCvtXmStringTableToTextProperty (display, string_table, count, style, text_prop_return) + Display *display; + XmStringTable string_table; + int count; + XmICCEncodingStyle style; + XTextProperty *text_prop_return; + + + + + + +DESCRIPTION +XmCvtXmStringTableToTextProperty converts the XmStrings +in the specified XmStringTable into an +XTextProperty structure. + +The function sets the encoding member of text_prop_return to an +Atom for the specified display naming the encoding determined by +the specified style, and it converts the first count compound +strings in the specified XmStringTable to this encoding for +storage in the text_prop_return value member. Following are the +possible encoding styles: + + + +XmSTYLE_COMPOUND_STRING + +The encoding is _MOTIF_COMPOUND_STRING. The function converts +each specified XmString to a compound string in Byte Stream +format. + + + + +XmSTYLE_COMPOUND_TEXT + +The encoding is COMPOUND_TEXT. The function converts each +specified XmString to compound text. + + + + +XmSTYLE_LOCALE + +The encoding is the encoding of the current locale. The function +converts each specified XmString to the encoding of the current +locale. + + + + +XmSTYLE_STRING + +The encoding is STRING (plain C strings encoded in ISO8859-1), and +the function converts each specified +XmString to STRING. + + + + +XmSTYLE_TEXT + +If all specified XmStrings are fully convertible to the +encoding of the current locale, the encoding is the encoding of the +current locale, and the function converts each specified +XmString to the encoding of the current locale. Otherwise, the +encoding is COMPOUND_TEXT, and the function converts each +specified compound +string to compound text. + + + + +XmSTYLE_STANDARD_ICC_TEXT + +If all specified XmStrings are fully convertible to STRING, the +encoding is STRING, and the function converts each specified +XmString +to STRING. Otherwise, the encoding is COMPOUND_TEXT, and the +function converts each specified XmString to compound text. + + + + + + +display + +Specifies the connection to the X server. + + + + +string_table + +Specifies a set of XmStrings. + + + + +count + +Specifies the number of XmStrings to be +converted in string_table. + + + + +style + +Specifies the manner in which the property is encoded. + + + + +text_prop_return + +Returns the XTextProperty structure. + + + + +To free the storage for the value member of the XTextProperty, use +XtFree. + + + +RETURN VALUES +If conversion depends on the locale and the +current locale is not supported, the function returns +XLocaleNotSupported. In both of these cases, the function does not set +text_prop_return. + +To determine whether the function is guaranteed not to return +XLocaleNotSupported, use XSupportsLocale. + + + +RELATED INFORMATION +&cdeman.XmCvtXmStringToByteStream;, +&cdeman.XmCvtTextPropertyToXmStringTable;, and +&cdeman.XmStringTable;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStB.sgm new file mode 100644 index 00000000..43e0114d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStB.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmCvtXmStringToByteStream +library call + + +XmCvtXmStringToByteStream +A compound string function that converts a compound string to a Byte Stream format + +XmCvtXmStringToByteStream + +compound string functions +XmCvtXmStringToByteStream + + + + + + + + + + + +#include <Xm/Xm.h> + +unsigned int XmCvtXmStringToByteStream + +XmString string +unsigned char **prop_return + + + +DESCRIPTION +XmCvtXmStringToByteStream converts a compound string to a +string of +bytes +representing the compound string in Byte Stream format. +This routine is typically used by the source of a data transfer +operation to produce a Byte Stream representation for transferring a compound +string to a destination. + +If prop_return is not NULL, this function creates a string of +characters in Byte Stream format and returns it in prop_return. +The function also returns the number of bytes in prop_return. +If prop_return is NULL, the function does not return the Byte +Stream format +string, but it does calculate and return the number of bytes that would +appear in the Byte Stream format string. + + + +string + +Specifies a compound string to be converted to Byte Stream format + + + + +prop_return + +Specifies a pointer to a string in Byte Stream format that is created and +returned by this function. +If prop_return is NULL, no Byte Stream format string is returned. +When a Byte Stream format string is returned, the function allocates +space to hold it. +The application is responsible for managing this allocated space. +The application can recover the allocated space by calling XtFree. + + + + + + +RETURN +Returns the number of bytes in the Byte Stream representation (whether or not +the Byte Stream representation is returned). + + + +RELATED +&cdeman.XmString; and +&cdeman.XmCvtByteStreamToXmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStC.sgm new file mode 100644 index 00000000..08daeb2a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/CvtXmStC.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmCvtXmStringToCT +library call + + +XmCvtXmStringToCT +A compound string function that converts a compound string to compound text + +XmCvtXmStringToCT + +compound string functions +XmCvtXmStringToCT + + + + + + + + + + + + +#include <Xm/Xm.h> + +char * XmCvtXmStringToCT + +XmString string + + + +DESCRIPTION +XmCvtXmStringToCT converts a compound string to a (char *) string +in compound text format. +The application must call XtAppInitialize before calling this +function. +The converter uses the font list tag associated with a given compound +string segment to select a compound text format for that segment. +A registry defines a mapping between font list tags and compound text +encoding formats. +The converter uses the following algorithm for each compound string +segment: + + + +If the compound string segment tag is mapped to +XmFONTLIST_DEFAULT_TAG in the registry, the converter passes the +text of the compound string segment to XmbTextListToTextProperty +with an encoding style of XCompoundTextStyle and uses the +resulting compound text for that segment. + + + +If the compound string segment tag is mapped to an MIT registered +charset in the registry, the converter creates the compound text for +that segment using the charset (from the registry) and the text of the +compound string segment as defined in the X Consortium Standard +Compound Text Encoding. + + + +If the compound string segment tag is mapped to a charset in the +registry that is neither XmFONTLIST_DEFAULT_TAG nor an MIT +registered charset, the converter creates the compound text for that +segment using the charset (from the registry) and the text of the +compound string segment as an "extended segment" with a variable number +of octets per character. + + + +If the compound string segment tag is not mapped in the registry, the +result is implementation dependent. + + + + + +string + +Specifies a compound string to be converted to compound text. + + + + + + +RETURN +Returns a (char *) string in compound text format. +This format is described in the X Consortium Standard Compound Text +Encoding. +The function allocates space to hold the returned string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XtFree. + + + +RELATED +&cdeman.XmCvtCTToXmString;, +&cdeman.XmFontList;, +&cdeman.XmMapSegmentEncoding;, +&cdeman.XmRegisterSegmentEncoding;, and +XmString. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivA.sgm new file mode 100644 index 00000000..bcac647c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivA.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmDeactivateProtocol +library call + + +XmDeactivateProtocol +A VendorShell function that deactivates a protocol without removing it + +XmDeactivateProtocol + +protocols + +VendorShell functions +XmDeactivateProtocol + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmDeactivateProtocol + +Widget shell +Atom property +Atom protocol + + + +DESCRIPTION +XmDeactivateProtocol deactivates a protocol without removing it. +It updates the handlers and the property if +the shell is realized. It is sometimes useful to allow +a protocol's state information (callback lists, and so on) to persist, even though +the client may choose to temporarily resign from the interaction. +The main use of this capability is to gray/ungray f.send_msg +entries in the MWM system menu. +To support this capability, protocol is allowed to be in +one of two states: active or inactive. +If protocol is active and shell is realized, +property contains the protocol Atom. +If protocol is inactive, Atom is not present in +the property. + +XmDeactivateWMProtocol is a convenience interface. +It calls XmDeactivateProtocol +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocol + +Specifies the protocol atom + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.mwm;, +&cdeman.VendorShell;, +&cdeman.XmActivateProtocol;, +&cdeman.XmDeactivateWMProtocol;, and +&cdeman.XmInternAtom;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivB.sgm new file mode 100644 index 00000000..112b5080 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DeactivB.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmDeactivateWMProtocol +library call + + +XmDeactivateWMProtocol +A VendorShell convenience interface that deactivates a protocol without removing it + +protocols + +XmDeactivateWMProtocol + +VendorShell functions +XmDeactivateWMProtocol + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmDeactivateWMProtocol + +Widget shell +Atom protocol + + + +DESCRIPTION +XmDeactivateWMProtocol is a convenience interface. +It calls XmDeactivateProtocol +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocol + +Specifies the protocol atom + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmActivateWMProtocol;, +&cdeman.XmDeactivateProtocol;, and +&cdeman.XmInternAtom;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DestroyP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DestroyP.sgm new file mode 100644 index 00000000..5c19e43c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DestroyP.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmDestroyPixmap +library call + + +XmDestroyPixmap +A pixmap caching function that removes a pixmap from the pixmap cache + +XmDestroyPixmap + +pixmaps + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmDestroyPixmap + +Screen * screen +Pixmap pixmap + + + +DESCRIPTION +XmDestroyPixmap removes pixmaps that are no longer used. +Pixmaps are completely freed only when there is no further reference to them. + + + +screen + +Specifies the display screen for which the pixmap was requested + + + + +pixmap + +Specifies the pixmap to be destroyed + + + + + + +RETURN +Returns True when successful; returns False if there is no matching screen +and pixmap in the pixmap cache. + + + +RELATED +&cdeman.XmInstallImage;, &cdeman.XmUninstallImage;, and +&cdeman.XmGetPixmap;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DialogSh.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DialogSh.sgm new file mode 100644 index 00000000..5d56d3ff --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DialogSh.sgm @@ -0,0 +1,865 @@ + + + + + + + + + + + +XmDialogShell +library call + + +XmDialogShell +The DialogShell widget class + +XmDialogShell + +widget class +DialogShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DialogS.h> + + + +DESCRIPTION +Modal and modeless dialogs use DialogShell as the Shell parent. +DialogShell widgets cannot +be iconified. Instead, all secondary DialogShell widgets +associated with an ApplicationShell widget are iconified and +de-iconified as a group with the primary widget. + +The client indirectly manipulates DialogShell through the convenience +interfaces during creation, and it can directly manipulate its +BulletinBoard-derived child. +Much of the functionality of DialogShell assumes +that its child is a BulletinBoard subclass, although it +can potentially stand alone. + +Setting XmNheight, XmNwidth, +or XmNborderWidth for +either a DialogShell or its managed child usually sets that resource to the +same value in both the parent and the child. When an off-the-spot input +method exists, the height and width of the shell may be greater than +those of the managed child in order to accommodate the input method. +In this case, setting XmNheight +or XmNwidth for the +shell does not necessarily set that resource to the same value in +the managed child, and setting XmNheight +or XmNwidth +for the child does not necessarily set that resource to the same +value in the shell. + +For the managed child of a DialogShell, regardless of the value of +the shell's XmNallowShellResize resource, +setting XmNx or XmNy +sets the corresponding resource of the parent but does not change the +child's position relative to the parent. +The XtGetValues resource for the child's +XmNx or XmNy yields the +value of the corresponding resource in the parent. +The x and y-coordinates of the child's upper left outside +corner relative to the parent's upper left inside corner are both 0 (zero) +minus the value of XmNborderWidth. + +Note that the Inter-Client Communication Conventions Manual (ICCCM) +allows a window manager to change or control the border width of a reparented +top-level window. + +DialogShell uses the XmQTdialogShellSavvy trait. + + +Classes +DialogShell inherits behavior, resources, and traits from the Core, +Composite, Shell, +WMShell, VendorShell, and TransientShell classes. + +The class pointer is xmDialogShellWidgetClass. + +The class name is XmDialogShell. + + + +New Resources +DialogShell defines no new resources but overrides the XmNdeleteResponse +resource in the VendorShell class. + + + +Inherited Resources +DialogShell inherits behavior and resources from the +superclasses described in the following tables, +which define sets of widget resources used by the programmer +to specify data. + +For a complete description of each resource, refer to the +reference page for that superclass. +The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the +XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable +(N/A). + + + + + + + + + + + +TransientShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNtransientFor +XmCTransientFor +Widget +NULL +CSG + + + + + + + + + + + + + + +VendorShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNaudibleWarning +XmCAudibleWarning +unsigned char +XmBELL +CSG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNdeleteResponse +XmCDeleteResponse +unsigned char +XmUNMAP +CSG + + +XmNinputMethod +XmCInputMethod +String +NULL +CSG + + +XmNinputPolicy +XmCInputPolicy +XmInputPolicy +XmPER_SHELL +CSG + + +XmNkeyboardFocusPolicy +XmCKeyboardFocusPolicy +unsigned char +XmEXPLICIT +CSG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTabel +XmRenderTable +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + +XmNmwmDecorations +XmCMwmDecorations +int +-1 +CG + + +XmNmwmFunctions +XmCMwmFunctions +int +-1 +CG + + +XmNmwmInputMode +XmCMwmInputMode +int +-1 +CG + + +XmNmwmMenu +XmCMwmMenu +String +NULL +CG + + +XmNpreeditType +XmCPreeditType +String +dynamic +CSG + + +XmNshellUnitType +XmCShellUnitType +unsigned char +XmPIXELS +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +XmPIXELS +CSG + + +XmNuseAsyncGeometry +XmCUseAsyncGeometry +Boolean +False +CSG + + + + + + + + + + + + + + +WMShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbaseHeight +XmCBaseHeight +int +XtUnspecifiedShellInt +CSG + + +XmNbaseWidth +XmCBaseWidth +int +XtUnspecifiedShellInt +CSG + + +XmNheightInc +XmCHeightInc +int +XtUnspecifiedShellInt +CSG + + +XmNiconMask +XmCIconMask +Pixmap +NULL +CSG + + +XmNiconPixmap +XmCIconPixmap +Pixmap +NULL +CSG + + +XmNiconWindow +XmCIconWindow +Window +NULL +CSG + + +XmNiconX +XmCIconX +int +XtUnspecifiedShellInt +CSG + + +XmNiconY +XmCIconY +int +XtUnspecifiedShellInt +CSG + + +XmNinitialState +XmCInitialState +int +NormalState +CSG + + +XmNinput +XmCInput +Boolean +True +CSG + + +XmNmaxAspectX +XmCMaxAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNmaxAspectY +XmCMaxAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNmaxHeight +XmCMaxHeight +int +XtUnspecifiedShellInt +CSG + + +XmNmaxWidth +XmCMaxWidth +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectX +XmCMinAspectX +int +XtUnspecifiedShellInt +CSG + + +XmNminAspectY +XmCMinAspectY +int +XtUnspecifiedShellInt +CSG + + +XmNminHeight +XmCMinHeight +int +XtUnspecifiedShellInt +CSG + + +XmNminWidth +XmCMinWidth +int +XtUnspecifiedShellInt +CSG + + +XmNtitle +XmCTitle +String +dynamic +CSG + + +XmNtitleEncoding +XmCTitleEncoding +Atom +dynamic +CSG + + +XmNtransient +XmCTransient +Boolean +True +CSG + + +XmNwaitForWm +XmCWaitForWm +Boolean +True +CSG + + +XmNwidthInc +XmCWidthInc +int +XtUnspecifiedShellInt +CSG + + +XmNwindowGroup +XmCWindowGroup +Window +dynamic +CSG + + +XmNwinGravity +XmCWinGravity +int +dynamic +CSG + + +XmNwmTimeout +XmCWmTimeout +int +5000 ms +CSG + + + + + + + +If values for XmNminWidth and XmNminHeight + are present, +and values for XmNbaseWidth and +XmNbaseHeight are absent, +XmNminWidth and +XmNminHeight will be used as +default values for XmNbaseWidth +and XmNbaseHeight, +and these values will be added to the shell size specified by the user. +To work around this, add arguments during widget +creation to explicitly set XmNbaseWidth and +XmNbaseHeight to zero. + + + + + + + + + + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +False +CG + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +False +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +True +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for XmDialogShell. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, &cdeman.Shell;, +&cdeman.TransientShell;, &cdeman.WMShell;, &cdeman.VendorShell;, +and &cdeman.XmCreateDialogShell;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectA.sgm new file mode 100644 index 00000000..32b4cc03 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectA.sgm @@ -0,0 +1,219 @@ + + + + + + + + + + + +XmDirection +library call + + +XmDirection +Data type for the direction of widget components + +XmDirection + +data types +XmDirection + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmDirection is the data type specifying the direction in which +the system displays subwidgets, children of +widgets, or other visual components that are to be laid out. +This data type also affects traversal order within tab groups. + +XmDirection is implemented as an unsigned char bit mask. +The horizontal and vertical directions can be specified independent of +each other. XmDirection also specifies the precedence of the +horizontal and vertical directions relative to each other. For +example, a value of XmRIGHT_TO_LEFT_TOP_TO_BOTTOM lays out a +component horizontally from right to left first, then vertically +top to bottom. + +XmDirection provides the following masks, each of which +corresponds to a particular bit in XmDirection: + + + +XmRIGHT_TO_LEFT_MASK + + + +XmLEFT_TO_RIGHT_MASK + + + +XmTOP_TO_BOTTOM_MASK + + + +XmBOTTOM_TO_TOP_MASK + + + +XmPRECEDENCE_HORIZ_MASK + + + +XmPRECEDENCE_VERT_MASK + + + +In addition to the preceding single bit masks, XmDirection +also provides the following multiple bit masks. These multiple +bit masks are particularly useful as arguments to +XmDirectionMatchPartial: + + + +XmHORIZONTAL_MASK + + + +XmPRECEDENCE_MASK + + + +XmVERTICAL_MASK + + + +Motif also provides the following enumerated constants for +specifying various combinations of directions: + + + +XmRIGHT_TO_LEFT_TOP_TO_BOTTOM + +Specifies that the components are laid out from right to left first, then +top to bottom. + + + + +XmLEFT_TO_RIGHT_TOP_TO_BOTTOM + +Specifies that the components are laid out from left to right first, then +top to bottom. + + + + +XmRIGHT_TO_LEFT_BOTTOM_TO_TOP + +Specifies that the components are laid out from right to left first, then +bottom to top. + + + + +XmLEFT_TO_RIGHT_BOTTOM_TO_TOP + +Specifies that the components are laid out from left to right first, then +bottom to top. + + + + +XmTOP_TO_BOTTOM_RIGHT_TO_LEFT + +Specifies that the components are laid out from top to bottom first, then +right to left. + + + + +XmTOP_TO_BOTTOM_LEFT_TO_RIGHT + +Specifies that the components are laid out from top to bottom first, then +left to right. + + + + +XmBOTTOM_TO_TOP_RIGHT_TO_LEFT + +Specifies that the components are laid out from bottom to top first, then +right to left. + + + + +XmBOTTOM_TO_TOP_LEFT_TO_RIGHT + +Specifies that the components are laid out from bottom to top first, then +left to right. + + + + +XmTOP_TO_BOTTOM + +Specifies that the components are laid out from top to bottom. +If horizontal direction is important, do not use this constant. + + + + +XmBOTTOM_TO_TOP + +Specifies that the components are laid out from bottom to top. +If horizontal direction is important, do not use this constant. + + + + +XmDEFAULT_DIRECTION + +Specifies that the components are laid out according to the default +direction. (This constant is primarily for widget writers.) + + + + +XmLEFT_TO_RIGHT + +Specifies that the components are laid out from left to right. +If vertical direction is important, do not use this constant. + + + + +XmRIGHT_TO_LEFT + +Specifies that the components are laid out from right to left. +If vertical direction is important, do not use this constant. + + + + + + +RELATED +&cdeman.XmDirectionMatch;, &cdeman.XmDirectionMatchPartial;, +&cdeman.XmDirectionToStringDirection;, &cdeman.XmString;, +&cdeman.XmStringDirection;, and +&cdeman.XmStringDirectionToDirection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectB.sgm new file mode 100644 index 00000000..7073d789 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectB.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmDirectionMatch +library call + + +XmDirectionMatch +A function that checks for a specified direction component + +XmDirectionMatch + + + + + + + + + + + + + +#include <Xm/Xm.h> +Boolean XmDirectionMatch (d1, d2) + XmDirection d1; + XmDirection d2; + + + + + + +DESCRIPTION +XmDirectionMatch compares two XmDirection values. +The function returns a Boolean value depending on whether or +not the two input values "match." +The simplest match is when d1 and d2 are identical. +However, other matches are possible. +XmDirectionMatch attempts to compare specified bits only; +nonspecified bits automatically match. + +For example, suppose that d1 equals +XmTOP_TO_BOTTOM_RIGHT_TO_LEFT. In this case, the function will +return True if d2 equals either XmRIGHT_TO_LEFT or +XmTOP_TO_BOTTOM. However, the function will return False if +d2 equals XmTOP_TO_BOTTOM_LEFT_TO_RIGHT, +XmBOTTOM_TO_TOP_RIGHT_TO_LEFT, or +XmBOTTOM_TO_TOP_LEFT_TO_RIGHT. + +Note that direction can be thought of as having three components, a +horizontal component, a vertical component, and the precedence among +them. This means that in addition to the previously mentioned +directions, the function will still return False if d1 equals +XmTOP_TO_BOTTOM_RIGHT_TO_LEFT and d2 equals +XmRIGHT_TO_LEFT_TOP_TO_BOTTOM. + + + +d1 + +Specifies an XmDirection value. + + + + +d2 + +Specifies an XmDirection value. + + + + + + +RETURN VALUES +Returns True if d1 "matches" d2; otherwise, returns False. + + + +RELATED INFORMATION +&cdeman.XmDirection;, +&cdeman.XmDirectionMatchPartial;, +&cdeman.XmDirectionToStringDirection;, &cdeman.XmString;, +&cdeman.XmStringDirection;, and +&cdeman.XmStringDirectionToDirection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectC.sgm new file mode 100644 index 00000000..051965c9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectC.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmDirectionMatchPartial +library call + + +XmDirectionMatchPartial +A function that checks for a specified direction component + +XmDirectionMatchPartial + + + + + + + + + + + + +#include <Xm/Xm.h> +Boolean XmDirectionMatchPartial (d1, d2, dmask) + XmDirection d1; + XmDirection d2; + XmDirection dmask; + + + + + + +DESCRIPTION +XmDirectionMatchPartial compares d1 and d2 along the +direction component specified by dmask. +For example, if dmask equals XmVERTICAL_MASK, then +the function will compare only the vertical components of d1 +and d2. + + + +d1 + +Specifies an XmDirection value to check. + + + + +d2 + +Specifies an XmDirection value to check. + + + + +dmask + +Specifies the direction component along which d1 and d2 +are to be checked. Appropriate values for dmask are +XmHORIZONTAL_MASK, +XmVERTICAL_MASK, +and +XmPRECEDENCE_MASK. + + + + + + +RETURN VALUES +Returns True if the d1 and d2 match in the component +specified by dmask; otherwise, returns False. + + + +RELATED INFORMATION +&cdeman.XmDirection;, &cdeman.XmDirectionMatch;, +&cdeman.XmDirectionToStringDirection;, +&cdeman.XmStringDirection;, and &cdeman.XmStringDirectionToDirection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectD.sgm new file mode 100644 index 00000000..fedaa200 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DirectD.sgm @@ -0,0 +1,110 @@ + + + + + + + + + + + +XmDirectionToStringDirection +library call + + +XmDirectionToStringDirection +A function that converts an XmDirection value to an XmStringDirection value + +XmDirectionToStringDirection + + + + + + + + + + + + +#include <Xm/Xm.h> +XmStringDirection XmDirectionToStringDirection (dir) + XmDirection dir; + + + + + + +DESCRIPTION +XmDirectionToStringDirection converts the specified +XmDirection +direction value to its equivalent XmStringDirection value. +Basically, if the XmDirection value has a horizontal direction +specification, +that horizontal element is used; otherwise, the +XmStringDirection value is interpreted as +XmSTRING_DIRECTION_L_TO_R. +This function provides backward compatibility with the +XmStringDirection data type. + +Note that the Motif toolkit also contains an +XmStringDirectionToDirection routine to convert an +XmStringDirection value to its XmDirection equivalent. + + + +dir + +Specifies the XmDirection value to be converted. + + + + + + +RETURN +Returns the following XmStringDirection values: + + + +XmSTRING_DIRECTION_R_TO_L + +If the dir argument has a right to left horizontal direction +value in it, for +example XmRIGHT_TO_LEFT_TOP_TO_BOTTOM. + + + + +XmSTRING_DIRECTION_L_TO_R + +If the dir argument has a left to right horizontal direction in +it, for example XmLEFT_TO_RIGHT_TOP_TO_BOTTOM, or if the +horizontal direction value in the dir argument is ambiguous, +such as in the XmTOP_TO_BOTTOM value. + + + + +XmSTRING_DIRECTION_DEFAULT + +If there was no horizontal direction specified. + + + + + + +RELATED INFORMATION +&cdeman.XmDirection;, &cdeman.XmDirectionMatch;, +&cdeman.XmDirectionMatchPartial;, +&cdeman.XmDirectionToStringDirection;, &cdeman.XmString;, +&cdeman.XmStringDirection;, and +&cdeman.XmStringDirectionToDirection;, + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Display.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Display.sgm new file mode 100644 index 00000000..f28cc601 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Display.sgm @@ -0,0 +1,890 @@ + + + + + + + + + + + +XmDisplay +library call + + +XmDisplay +The Display widget class + +XmDisplay + +widget class +XmDisplay + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Display.h> + + + +DESCRIPTION +The XmDisplay object is used by the Motif widgets to store information +that is specific to a display. It also allows the toolkit to access +certain information on widget hierarchies that would otherwise be +unavailable. Each client has one XmDisplay object for each display +it accesses. + +An XmDisplay object is automatically created when the application +creates the first shell on a display (usually accomplished by a call to +XtAppInitialize or XtAppCreateShell). +It is not necessary to create an XmDisplay object by any other means. +An application can use the function XmGetXmDisplay to obtain the +widget ID of the XmDisplay object for a given display. + +An application cannot supply initial values for XmDisplay resources as +arguments to a call to any function that creates widgets. +The application or user can supply initial values in a resource file. +After creating the first shell on the display, the application can use +XmGetXmDisplay to obtain the widget ID of the XmDisplay object and +then call XtSetValues to set the XmDisplay resources. + +XmDisplay resources specify the drag protocol style for a client +participating in drag and drop transactions. The two basic +protocol types are preregister and dynamic. When a preregister protocol +is used, the toolkit handles any communication between the initiator +and receiver clients and displays the appropriate drag-over and +drag-under visual effects. A client registers its drop sites in +advance and this information is stored in a property for each +top-level window. When the drag pointer enters a top-level window, +the drop site information is read by the initiator. A dynamic +protocol allows the source and destination clients to dynamically +communicate drag and drop state information between each other, and +to update their respective visuals accordingly. The toolkit provides +drop site information as the pointer passes over any given drop site. +In this mode, a receiver can supply a procedure to generate its +own drag-under effects. + + +Classes +Display inherits behavior and resources from Core, Composite, +Shell, WMShell, VendorShell, TopLevelShell, and +ApplicationShell classes. + +The class pointer is xmDisplayClass. + +The class name is XmDisplay. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in a .Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in a .Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate if the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmDisplay Resource Set + + +Name +Class +Type +Default +Access + + +XmNdefaultButtonEmphasis +XmCDefaultButtonEmphasis +XtEnum +XmEXTERNAL_HIGHLIGHT +C + + +XmNdefaultVirtualBindings +XmCDefaultVirtualBindings +String +dynamic +C + + +XmNdragInitiatorProtocolStyle +XmCDragInitiatorProtocolStyle +unsigned char +XmDRAG_PREFER_RECEIVER +CG + + +XmNdragReceiverProtocolStyle +XmCDragReceiverProtocolStyle +unsigned char +XmDRAG_PREFER_DYNAMIC +CG + + +XmNdragStartCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNenableBtn1Transfer +XmCEnableBtn1Transfer +XtEnum +XmOFF +C + + +XmNenableButtonTab +XmCEnableButtonTab +Boolean +False +C + + +XmNenableDragIcon +XmCEnableDragIcon +Boolean +False +C + + +XmNenableEtchedInMenu +XmCEnableEtchedInMenu +Boolean +False +C + + +XmNenableToggleColor +XmCEnableToggleColor +Boolean +False +C + + +XmNenableToggleVisual +XmCEnableToggleVisual +Boolean +False +C + + +XmNenableUnselectableDrag +XmCEnableUnselectableDrag +Boolean +True +C + + +XmNenableWarp +XmCEnableWarp +XtEnum +True +CSG + + +XmNmotifVersion +XmCMotifVersion +int +XmVERSION +CSG + + +XmNnoFontCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNnoRenditionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + +XmNdefaultButtonEmphasis + +Specifies whether to change the look of the PushButton widget and +gadget that have the XmNshowAsDefault resource set. When the +PushButton is the default, it has an etched out button which is +enclosed with another etched in border. The +XmNdefaultButtonEmphasis has the follow possible values, which +affect the location cursor: + + + +XmINTERNAL_HIGHLIGHT + +Causes the location cursor to appear in between the two etched borders +to minimize the space required. + + + + +XmEXTERNAL_HIGHLIGHT + +Causes the PushButton to draw the location cursor outside the second border. + + + + + + + +XmNdefaultVirtualBindings + +Specifies the default virtual bindings for the display. +Following is an example of a specification for the +defaultVirtualBindings resource in a resource file: + + +*defaultVirtualBindings: \ + osfBackSpace: <Key>BackSpace \n\ + osfInsert: <Key>InsertChar \n\ + osfDelete: <Key>DeleteChar \n\ + ... + osfLeft: <Key>left, Ctrl<Key>H + + + + + +XmNdragInitiatorProtocolStyle + +Specifies the drag and drop protocol requirements or preference when +the client is an initiator. The possible values are + + + +XmDRAG_PREREGISTER + +As an initiator, this client does not use the dynamic protocol and +can only arrange visual effects with receivers who provide +preregistered information. + + + + +XmDRAG_DYNAMIC + +As an initiator, this client does not make use of any preregistered +drop site information made available by other clients, and can only +arrange visual effects with receivers who use the dynamic protocol. + + + + +XmDRAG_NONE + +Specifies that drag and drop is disabled for this client. + + + + +XmDRAG_DROP_ONLY + +As an initiator, this client does not use either the preregistered +drop site information or the dynamic protocol. It supports dragging, +and any time the cursor is over a client that supports drag and +drop, valid feedback is provided. There are no other visual effects. + + + + +XmDRAG_PREFER_DYNAMIC + +As an initiator, this client can support both the preregister and +dynamic protocols, but prefers to use dynamic protocols whenever +possible in order to provide high-quality drag-under feedback. + + + + +XmDRAG_PREFER_PREREGISTER + +As an initiator, this client can support both the preregister and +dynamic protocols, but prefers to use the preregister protocol +whenever possible in order to accommodate performance needs or to +provide consistent drag-over feedback. + + + + +XmDRAG_PREFER_RECEIVER + +Indicates that this client can support both preregister and dynamic +protocols, but will defer to the preference of the receiver client. +This value is valid only for the XmNdragInitiatorProtocolStyle +resource, and is its default value. + + + + + + + +XmNdragReceiverProtocolStyle + +Specifies the drag and drop protocol requirements or preference +when this client is a receiver. The values are + + + +XmDRAG_PREREGISTER + +As a receiver, this client preregisters drop site information and +does not use the dynamic protocol. It can only arrange visual +effects with initiators who make use of the preregistered information. + + + + +XmDRAG_DYNAMIC + +As a receiver, this client uses the dynamic protocol and does +not preregister drop site information. It can only arrange visual +effects with initiators who use the dynamic protocol. + + + + +XmDRAG_NONE + +Specifies that drag and drop is disabled for this client. + + + + +XmDRAG_DROP_ONLY + +As a receiver, this client neither uses the dynamic protocol +nor preregisters drop site information. It supports +dropping, and when dragging over this client, valid feedback +is always provided, but there are no other visual effects. + + + + +XmDRAG_PREFER_DYNAMIC + +As a receiver, this client can support both the preregister and +dynamic protocols, but prefers to use the dynamic protocol whenever +possible in order to provide high-quality drag-under feedback. + + + + +XmDRAG_PREFER_PREREGISTER + +As a receiver, this client can support both the preregister and +dynamic protocols, but prefers to use the preregister protocol +whenever possible in order to accommodate performance +needs. + + + + +The default value of this resource is dependent on the capabilities of +the display. If the display supports the shape extension, allowing the +dynamic protocol to use arbitrarily sized drag cursors, the default of +this resource is XmDRAG_PREFER_DYNAMIC, otherwise the default is +XmDRAG_PREFER_PREREGISTER. + +The actual protocol used between an initiator and a receiver +is based on the protocol style of the receiver and initiator. The +decision matrix is described in the following table. + + + + + + + + + + + +Drag Initiator +Protocol Style +Drag Receiver Protocol Style + + + +Preregister +Prefer Preregister +Prefer Dynamic +Dynamic + + +Preregister +Preregister +Preregister +Preregister +Drop Only + + +Prefer Preregister +Preregister +Preregister +Preregister +Dynamic + + +Prefer Receiver +Preregister +Preregister +Dynamic +Dynamic + + +Prefer Dynamic +Preregister +Dynamic +Dynamic +Dynamic + + +Dynamic +Drop Only +Dynamic +Dynamic +Dynamic + + + + +The value XmDRAG_NONE does not appear in the +matrix. When specified for either the initiator or receiver side, +XmDRAG_NONE implies that drag and drop transactions are not +supported. A value of XmDRAG_DROP_ONLY (Drop Only) results +when an initiator and receiver cannot compromise protocol styles, +that is, one client requires dynamic mode while the other +can only support preregister mode, or if either explicitly has +specified XmDRAG_DROP_ONLY. + + + + +XmNdragStartCallback + +Specifies the list of callbacks that are invoked when the +XmDragStart function is called. The type of structure whose +address is passed to this callback is XmDragStartCallbackStruct. +The callback reason +is XmCR_DRAG_START. + + + + +XmNenableBtn1Transfer + +Specifies if selection and transfer actions are integrated on Btn1 +and extend actions are activated on Btn2. This resource +can take the following values: + + + +XmOFF + +Disables integration and selection activation on Btn1. + + + + +XmBUTTON2_TRANSFER + +Enables integration and selection activation on Btn1 and transfer on Btn2. + + + + +XmBUTTON2_ADJUST + +Enables integration and selection activation on Btn1 and adjust on Btn2. + + + + +This +resource affects the actions of Text, TextField, List, and Container. + + + + +XmNenableButtonTab + +Specifies if the action for the +Tab key (KNextField and KPrevField actions) is to be modified. +A value of True modifies the key to move as an arrow key until the +boundary of a tab group is reached. Then, at the boundary of the +tab group, KNextField and KPrevField will move to the next +or previous tab group, respectively. A value of False does not cause +modification. + + + + +XmNenableDragIcon + +Specifies which set of icons are to be used for system default cursors +during drag and drop operations. A value of False specifies that +earlier versions of Motif release icons are used, a value of True +specifies that +alternate icons are used. This resource affects both the 16x16 and +the 32x32 icons that the system defaults for each of the Screen +objects associated with this display. + + + + +XmNenableEtchedInMenu + +Specifies the shadowing of the button widgets and gadgets in menus +when the control is activated. A value of True causes the selected +menu to be drawn with the shadow etched in; this shadow style is +consistent with the selected appearance of other button widgets +outside of menus. A value of False causes +the selected menu to be draw with the shadow etched out. This +resource affects the actions of PushButton, ToggleButton, and +CascadeButton widgets and gadgets when they are children of Menu. + +When this resource is set, the background of a button in a menu +uses the XmNselectColor +(derived from the XmNselectPixel) when armed +as a default. A PushButton +uses the XmNarmColor +if it is defined. A ToggleButton +uses the XmNselectColor +if XmNindicatorOn +is False and XmNfillOnSelect +is True. + + + + +XmNenableToggleColor + +Specifies how to determine the default value of the +XmNselectColor resource of ToggleButton and ToggleButtonGadget. +A value of True causes the default value of XmNselectColor +to be set to the value of XmNhighlightColor. +A value of False causes the default value of XmNselectColor +to be set to the value of XmNbackground. +This resource only affects the appearance of ToggleButton +widgets and gadgets that are in XmONE_OF_MANY or +XmONE_OF_MANY_ROUND mode. In addition, XmNenableToggleColor +only influences the default value of XmNselectColor. That is, +if the user or application sets a value for XmNselectColor, +then XmNenableToggleColor is ignored. + + + + +XmNenableToggleVisual + +Specifies the visual appearance of the ToggleButton widget and/or +gadget. This resource affects the default value of the ToggleButton[Gadget] +XmNindicatorType and XmNindicatorOn resources. When the +ToggleButton is in a RadioBox, a value of True causes the +XmONE_OF_MANY_ROUND (a shadowed circle) to be the default. +Otherwise, when this resource is True, the ToggleButton +XmNindicatorOn resource causes a default of XmN_OF_MANY, +which will be a shadowed square with a check mark (check box). + +A value of False causes the following: + + + +XmONE_OF_MANY + +Is a shadowed diamond. + + + + +XmN_OF_MANY + +Is a shadowed square. + + + + + + + +XmNenableUnselectableDrag + +Specifies whether or not it is possible to drag from Label and Scale. +A value of True enables the drag; a value of False disables it. + + + + +XmNenableWarp + +Specifies if an application is allowed to warp the pointer +from the user. A value of True enables warping, a value of False does not. + + + + +XmNmotifVersion + +Specifies the current version of Motif that the current implementation +is supposed to +behave like. By default, this resource gets its value from release +values in Xm.h. + + + + +XmNnoFontCallback + +This callback is called whenever a rendition attempts to load a font +or fontset and fails. This can happen on creation if the font is +specified as XmLOAD_IMMEDIATE or when an attempt is made to +render an XmString using a font specified as +XmLOAD_DEFERRED. An application can have this callback attempt +to remedy this problem by calling XmRenditionUpdate on the input +rendition to provide a font for the widget to use. This may be done by +either providing an an alternative font name to be loaded using the +XmNfontName and XmNfontType resources or with an already +loaded font using the XmNfont resource. The callback reason is +XmCR_NO_FONT. This callback uses the +XmDisplayCallbackStruct structure. + + + + +XmNnoRenditionCallback + +This callback is called whenever an attempt is made to render a +segment with a RENDITION tag which does not match any renditions +in a given render table. The callback reason is +XmCR_NO_RENDITION. This callback uses the +XmDisplayCallbackStruct structure. + +An application can have this callback attempt to remedy this problem +by creating a new +rendition with the given tag and adding it to render_table. + +The XmNnoRenditionCallback should deallocate the render table passed in +in the render_table field of the callback structure. Note that +the table +will automatically be deallocated if the +XmRenderTableAddRenditions function is +called on it. The callback should NOT deallocate the modified render +table that is passed back to Motif in the render_table +field. If the +application wishes to manipulate this render table further, it should +make a copy with the XmRenderTableCopy function before returning +from the callback. + + + + +XmNuserData + +Specifies a client data pointer for applications. An internally +unused resource. + + + + + + +Inherited Resources +All of the superclass resources inherited by XmDisplay are +designated N/A (not applicable). + + + +Callback Information +A pointer to the following structure is passed to the +XmNdragStartCallback callback: + +typedef struct +{ + int reason; + XEvent *event; + Widget timeStamp; + Boolean doit; +}XmDragStartCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +widget + +Indicates the ID of the widget from which the drag was initiated. + + + + +doit + +Is an IN/OUT member that allows the callback to determine whether to +continue with the drag or cancel. Setting doit to +False will cancel the drag. The default value is NULL. + + + + +A pointer to the following structure is passed to the +XmNnoFontCallback and XmNnoRenditionCallback callbacks: + +typedef struct +{ + int reason; + XEvent *event; + XmRendition rendition; + char *font_name; + XmRenderTable render_table; + XmStringTag tag; +}XmDisplayCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +rendition + +Specifies the rendition with the missing font. + + + + +font_name + +Specifies the name of the font or font set which could not be loaded. + + + + +render_table + +Specifies the render table with the missing rendition. + + + + +tag + +Specifies the tag of the missing rendition. + + + + +The following table describes the reasons for which the individual +callback structure fields are valid. + + + + + + + +Reason +Valid Fields + + +XmCR_NO_FONT +rendition, font_name + + +XmCR_NO_RENDITION +render_table, tag + + + + + + + +RELATED +&cdeman.ApplicationShell;, +&cdeman.Composite;, +&cdeman.Core;, +&cdeman.TopLevelShell;, +&cdeman.VendorShell;, +&cdeman.WMShell;, +&cdeman.XmGetXmDisplay;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCanc.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCanc.sgm new file mode 100644 index 00000000..d1863d34 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCanc.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +XmDragCancel +library call + + +XmDragCancel +A Drag and Drop function that terminates a drag +transaction + +XmDragCancel + +Drag and Drop functions +XmDragCancel + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDragCancel + +Widget dragcontext + + + +DESCRIPTION +XmDragCancel terminates a drag operation and cancels +any pending actions of the specified DragContext. This routine +can only be called by the initiator client. + + + +dragcontext + +Specifies the ID of the DragContext widget associated with the +drag and drop transaction to be terminated + + + + +For a complete definition of DragContext and its associated resources, +see &cdeman.XmDragContext;. + + + +RELATED +&cdeman.XmDragContext; and +&cdeman.XmDragStart;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCont.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCont.sgm new file mode 100644 index 00000000..daee146c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragCont.sgm @@ -0,0 +1,1880 @@ + + + + + + + + + + + +XmDragContext +library call + + +XmDragContext +The DragContext widget class + +XmDragContext + +widget class +DragContext + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DragDrop.h> + + + +DESCRIPTION +DragContexts are special widgets used in drag and drop transactions. +A DragContext is implemented as a widget, but a client does not +explicitly create a DragContext widget. Instead, a client initiates +a drag and drop transaction by calling XmDragStart, and this +routine initializes and returns a DragContext widget. There is a +unique DragContext for each drag operation. The toolkit frees a +DragContext when a transaction is complete; therefore, an application +programmer should not explicitly destroy a DragContext. + +Initiator and receiver clients both use DragContexts to track +the state of a transaction. When the initiator and receiver of +a transaction are in the same client, they share the same +DragContext instance. If they are in different clients, there +are two separate DragContexts. In this case, the initiator calls +XmDragStart and the toolkit provides a DragContext for the +receiver client. The only resources pertinent to the receiver +are XmNexportTargets and XmNnumExportTargets. These +can both be passed as arguments to the XmDropSiteRetrieve +function to obtain information about the current drop site. + +In general, in order to receive data, a drop site must share at least +one target type and operation in common with a drag source. The +DragContext resource, XmNexportTargets, identifies the selection +targets for the drag source. These export targets are compared with the +XmNimportTargets resource list specified by a drop site. +The DragContext resource, XmNdragOperations, identifies the +valid operations that can be applied to the source data by the +initiator. The drop site counterpart resource is +XmNdropSiteOperations, which indicates a drop site's supported +operations. + +A client uses DragIcon widgets to define the drag-over animation +effects associated with a given drag and drop transaction. +An initiator specifies a set of drag icons, selects a blending +model, and sets foreground and background cursor colors with +DragContext resources. + +The type of drag-over visual used to represent a drag operation +depends on the drag protocol style. In preregister mode, the server +is grabbed, and either a cursor or a pixmap may be used as a drag-over +visual. In dynamic mode, drag-over visuals must be +implemented with the X cursor. If the resulting drag protocol style is +Drop Only or None and the XmNdragInitiatorProtocolStyle is +XmDRAG_DYNAMIC or XmDRAG_PREFER_DYNAMIC, +then a dynamic visual style (cursor) is used. Otherwise, a preregister +visual style is used. + + +Classes +DragContext inherits behavior and resources from Core. + +The class pointer is xmDragContextClass. + +The class name is XmDragContext. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the +resource values for the inherited classes to set attributes for +this widget. To reference a resource by name or by class in +a .Xdefaults file, remove the XmN or XmC prefix and use +the remaining letters. To specify one of the defined values for a +resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include +any underscores between words). The codes in the access column +indicate if the given resource can be set at creation time (C), +set by using XtSetValues (S), retrieved by using +XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmDragContext Resource Set + + +Name +Class +Type +Default +Access + + +XmNblendModel +XmCBlendModel +unsigned char +XmBLEND_ALL +CG + + +XmNclientData +XmCClientData +XtPointer +NULL +CSG + + +XmNconvertProc +XmCConvertProc +XtConvertSelectionIncrProc +NULL +CSG + + +XmNcursorBackground +XmCCursorBackground +Pixel +dynamic +CSG + + + +XmNcursorForeground +XmCCursorForeground +Pixel +dynamic +CSG + + +XmNdragDropFinishCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNdragMotionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdragOperations +XmCDragOperations +unsigned char +XmDROP_COPY | XmDROP_MOVE +C + + +XmNdropFinishCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdropSiteEnterCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdropSiteLeaveCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdropStartCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNexportTargets +XmCExportTargets +Atom * +NULL +CSG + + +XmNincremental +XmCIncremental +Boolean +False +CSG + + +XmNinvalidCursorForeground +XmCCursorForeground +Pixel +dynamic +CSG + + +XmNnoneCursorForeground +XmCCursorForeground +Pixel +dynamic +CSG + + +XmNnumExportTargets +XmCNumExportTargets +Cardinal +0 +CSG + + +XmNoperationChangedCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNoperationCursorIcon +XmCOperationCursorIcon +Widget +dynamic +CSG + + +XmNsourceCursorIcon +XmCSourceCursorIcon +Widget +dynamic +CSG + + +XmNsourcePixmapIcon +XmCSourcePixmapIcon +Widget +dynamic +CSG + + +XmNstateCursorIcon +XmCStateCursorIcon +Widget +dynamic +CSG + + +XmNtopLevelEnterCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNtopLevelLeaveCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNvalidCursorForeground +XmCCursorForeground +Pixel +dynamic +CSG + + + + + + +XmNblendModel + +Specifies which combination of DragIcons are blended to produce +a drag-over visual. + + + +XmBLEND_ALL + +Blends all three DragIcons: the source, state and operation icons. +The icons are layered from top to bottom with the operation icon +on top and the source icon on the bottom. +The hotspot is derived from the state icon. + + + + +XmBLEND_STATE_SOURCE + +Blends the state and source icons only. The hotspot is derived +from the state icon. + + + + +XmBLEND_JUST_SOURCE + +Specifies that only the source icon is used, which the initiator +updates as required. + + + + +XmBLEND_NONE + +Specifies that no drag-over visual is generated. The client +tracks the drop site status through callback routines and updates +the drag-over visuals as necessary. + + + + + + + +XmNclientData + +Specifies the client data to be passed to XmNconvertProc +when it is invoked. + + + + +XmNconvertProc + +If XmNincremental is True, specifies a procedure of type +XtConvertSelectionIncrProc that +converts the source data to the format(s) requested by the receiver +client. +The widget argument passed to this procedure is the DragContext +widget. +The selection atom passed is _MOTIF_DROP. +If XmNincremental is False, the procedure is an +XtConvertSelectionProc, and should ignore the +max_length, client_data, and request_id arguments and +should handle the conversion atomically. +Data returned by XmNconvertProc must be allocated using +XtMalloc, and will be freed automatically by the toolkit after the +transfer. +For additional information on selection conversion procedures, see X +Toolkit Intrinsics—C Language Interface. + + + + +XmNcursorBackground + +Specifies the background pixel value of the cursor. + + + + +XmNcursorForeground + +Specifies the foreground pixel value of the cursor when the state icon +is not blended. This resource defaults to the foreground color of the +widget passed to the XmDragStart function. + + + + +XmNdragDropFinishCallback + +Specifies the list of callbacks that are called when the transaction is +completed. The type of the structure whose address is passed to this +callback is XmDragDropFinishCallbackStruct. The reason sent by +the callback is XmCR_DRAG_DROP_FINISH. + + + + +XmNdragMotionCallback + +Specifies the list of callbacks that are invoked when the pointer moves. +The type of structure whose address is passed to this callback is +XmDragMotionCallbackStruct. The reason sent by the callback +is XmCR_DRAG_MOTION. + + + + +XmNdragOperations + +Specifies the set of valid operations associated with an initiator +client for a drag transaction. +This resource is a bit mask that is formed by combining one or +more of the following values using a bitwise operation such as +inclusive OR (|): +XmDROP_COPY, XmDROP_LINK, XmDROP_MOVE. +The value XmDROP_NOOP for this resource indicates that no +operations are valid. +For Text and TextField widgets, this resource is set to +XmDROP_COPY | XmDROP_MOVE; for List widgets, it is set to +XmDROP_COPY. + + + + +XmNdropFinishCallback + +Specifies the list of callbacks that are invoked when the drop +is completed. The type of the structure whose address is passed to +this callback is XmDropFinishCallbackStruct. The reason sent +by the callback is XmCR_DROP_FINISH. + + + + +XmNdropSiteEnterCallback + +Specifies the list of callbacks that are invoked when the pointer enters +a drop site. The type of the structure whose address is passed to this +callback is XmDropSiteEnterCallbackStruct. The reason sent by the +callback is XmCR_DROP_SITE_ENTER. + + + + +XmNdropSiteLeaveCallback + +Specifies the list of callbacks that are invoked when the pointer leaves +a drop site. The type of the structure whose address is passed to this +callback is XmDropSiteLeaveCallbackStruct. The reason sent by +the callback is XmCR_DROP_SITE_LEAVE. + + + + +XmNdropStartCallback + +Specifies the list of callbacks that are invoked when a drop is +initiated. The type of the structure whose address is passed to this +callback is XmDropStartCallbackStruct. The reason sent by the +callback is XmCR_DROP_START. + + + + +XmNexportTargets + +Specifies the list of target atoms associated with this source. +This resource identifies the selection targets this source +can be converted to. + + + + +XmNincremental + +Specifies a Boolean value that indicates whether the transfer on the +initiator side uses the Xt incremental selection transfer mechanism +described in X Toolkit Intrinsics—C Language Interface. +If the value is True, the initiator uses incremental transfer; if the +value is False, the initiator uses atomic transfer. + + + + +XmNinvalidCursorForeground + +Specifies the foreground pixel value of the cursor when the state +is invalid. This resource defaults to the value of the +XmNcursorForeground resource. + + + + +XmNnoneCursorForeground + +Specifies the foreground pixel value of the cursor when the state +is none. This resource defaults to the value of the +XmNcursorForeground resource. + + + + +XmNnumExportTargets + +Specifies the number of entries in the list of export targets. + + + + +XmNoperationChangedCallback + +Specifies the list of callbacks that are invoked when the drag +is started and when the user requests that a different operation +be applied to the drop. +The type of the structure whose address is passed to this callback +is XmOperationChangedCallbackStruct. The reason sent by the +callback is XmCR_OPERATION_CHANGED. + + + + +XmNoperationCursorIcon + +Specifies the cursor icon used to designate the type of operation +performed by the drag transaction. If NULL, XmScreen +resources provide default icons for copy, link, and move +operations. + + + + +XmNsourceCursorIcon + +Specifies the cursor icon used to represent the source when +a dynamic visual style is used. If NULL, the +XmNdefaultSourceCursorIcon resource of XmScreen provides +a default cursor icon. + + + + +XmNsourcePixmapIcon + +Specifies the pixmap icon used to represent the source when +a preregister visual style is used. The icon is used in conjunction +with the colormap of the widget passed to XmDragStart. +If NULL, XmNsourceCursorIcon is used. + + + + +XmNstateCursorIcon + +Specifies the cursor icon used to designate the state of a drop site. +If NULL, XmScreen resources provide default icons for a valid, +invalid, and no drop site condition. + + + + +XmNtopLevelEnterCallback + +Specifies the list of callbacks that are called when the pointer enters +a top-level window or root window (due to changing screens). The type +of the structure whose address is passed to this callback is +XmTopLevelEnterCallbackStruct. The reason sent by the +callback is XmCR_TOP_LEVEL_ENTER. + + + + +XmNtopLevelLeaveCallback + +Specifies the list of callbacks that are called when the pointer +leaves a top level window or the root window (due to changing +screens). The type of the structure whose address is +passed to this callback is XmTopLevelLeaveCallbackStruct. The +reason sent by the callback is XmCR_TOP_LEVEL_LEAVE. + + + + +XmNvalidCursorForeground + +Specifies the foreground pixel value of the cursor designated as a +valid cursor icon. + + + + + + +Inherited Resources +DragContext inherits behavior and resources from the superclass +described in the following table. +For a complete description of each resource, refer +to the Core reference page. + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +Each of the DragContext callbacks has an associated callback +structure. + +A pointer to the following structure is passed to the +XmNdragDropFinishCallback callback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; +}XmDragDropFinishCallbackStruct, *XmDragDropFinishCallback; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +timeStamp + +Specifies the time at which either the drag or the drop was completed + + + + +A pointer to the following structure is passed to callbacks for +XmNdragMotionCallback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + unsigned char operation; + unsigned char operations; + unsigned char dropSiteStatus; + Position x; + Position y; +}XmDragMotionCallbackStruct, *XmDragMotionCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the timestamp of the logical event. + + + + +operation + +Identifies an operation. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operation to the value of the operation +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. + +If the toolkit has not called an XmNdragProc and the pointer is +within an active drop site, the toolkit initializes operation by +selecting an operation from the bitwise AND of the initial value of the +operations member and the value of the DropSite's +XmNdropSiteOperations resource. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + +If the toolkit has not called an XmNdragProc and the pointer is +not within an active drop site, the toolkit initializes operation +by selecting an operation from the initial value of the operations +member. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + + + + +operations + +Indicates the set of operations supported for the source data. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operations to the bitwise AND of the +DropSite's XmNdropOperations and the value of the operations +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +If the toolkit has not called an XmNdragProc and the user does not +select an operation (by pressing a modifier key), the toolkit +initializes operations to the value of the DragContext's +XmNdragOperations resource. + +If the toolkit has not called an XmNdragProc and the user does +select an operation, the toolkit initializes operations to the +bitwise AND of the corresponding operation and the value of the +DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + + + + +dropSiteStatus + +Indicates whether or not a drop site is valid. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes dropSiteStatus to the value of the +dropSiteStatus member of the XmDragProcCallbackStruct at the +time the DropSite's XmNdragProc returns. + +If the toolkit has not called an XmNdragProc, it initializes +dropSiteStatus as follows: +the toolkit initializes dropSiteStatus to XmNO_DROP_SITE if +the pointer is over an inactive drop site or is not over a drop site. +The toolkit initializes dropSiteStatus to XmDROP_SITE_VALID +if all the following conditions are met: + + + +The pointer is over an active drop site. + + + +The DragContext's XmNexportTargets and the DropSite's +XmNimportTargets are compatible. + + + +The initial value of the operation member is not +XmDROP_NOOP. + + + +Otherwise, the toolkit initializes dropSiteStatus to +XmDROP_SITE_INVALID. + + + + +A pointer to the following structure is passed for the +XmNdropFinishCallback callback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + unsigned char operation; + unsigned char operations; + unsigned char dropSiteStatus; + unsigned char dropAction; + unsigned char completionStatus; +}XmDropFinishCallbackStruct, *XmDropFinishCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the time at which the drop was completed. + + + + +operation + +Identifies an operation. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes operation to the value of the operation +member of the XmDropProcCallbackStruct at the time the DropSite's +XmNdropProc returns. + +If the pointer is not over an active drop site when the drop begins, the +toolkit initializes operation by selecting an operation from the +initial value of the operations member. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If it finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + + + + +operations + +Indicates the set of operations supported for the source data. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes operations to the bitwise AND of the +DropSite's XmNdropOperations and the value of the operations +member of the XmDropProcCallbackStruct at the time the DropSite's +XmNdropProc returns. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +If the pointer is not over an active drop site when the drop begins and +if the user does not select an operation (by pressing a modifier key), +the toolkit initializes operations to the value of the +DragContext's XmNdragOperations resource. + +If the pointer is not over an active drop site when the drop begins and +if the user does select an operation, the toolkit initializes +operations to the bitwise AND of the corresponding operation and +the value of the DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + + + + +dropSiteStatus + +Indicates whether or not a drop site is valid. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes dropSiteStatus to the value of the +dropSiteStatus member of the XmDropProcCallbackStruct at the +time the DropSite's XmNdropProc returns. + +If the pointer is not over an active drop site when the drop begins, the +toolkit initializes dropSiteStatus to XmNO_DROP_SITE. + + + + +dropAction + +Identifies the drop action. The values are XmDROP, +XmDROP_CANCEL, XmDROP_HELP, and XmDROP_INTERRUPT. +The XmDROP_INTERRUPT value is currently unsupported; if +specified, it will be interpreted as an XmDROP_CANCEL. + + + + +completionStatus + +An IN/OUT member that indicates the status of the drop action. +After the last callback procedure has returned, the final value of this +member determines what visual transition effects will be applied. +There are two values: + + + +XmDROP_SUCCESS + +The drop was successful. + + + + +XmDROP_FAILURE + +The drop was unsuccessful. + + + + + + + +A pointer to the following structure is passed to callbacks for +XmNdropSiteEnterCallback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + unsigned char operation; + unsigned char operations; + unsigned char dropSiteStatus; + Position x; + Position y; +}XmDropSiteEnterCallbackStruct, *XmDropSiteEnterCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the time the crossing event occurred. + + + + +operation + +Identifies an operation. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operation to the value of the operation +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. + +If the toolkit has not called an XmNdragProc, it initializes +operation by selecting an operation from the bitwise AND of the +initial value of the operations member and the value of the +DropSite's XmNdropSiteOperations resource. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + + + + +operations + +Indicates the set of operations supported for the source data. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operations to the bitwise AND of the +DropSite's XmNdropOperations and the value of the operations +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +If the toolkit has not called an XmNdragProc and the user does not +select an operation (by pressing a modifier key), the toolkit +initializes operations to the value of the DragContext's +XmNdragOperations resource. + +If the toolkit has not called an XmNdragProc and the user does +select an operation, the toolkit initializes operations to the +bitwise AND of the corresponding operation and the value of the +DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + + + + +dropSiteStatus + +Indicates whether or not a drop site is valid. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes dropSiteStatus to the value of the +dropSiteStatus member of the XmDragProcCallbackStruct at the +time the DropSite's XmNdragProc returns. + +If the toolkit has not called XmNdragProc, it initializes +dropSiteStatus to XmDROP_SITE_VALID +if the DragContext's XmNexportTargets and the DropSite's +XmNimportTargets are compatible and if the initial value of the +operation member is not XmDROP_NOOP. +Otherwise, the toolkit initializes dropSiteStatus to +XmDROP_SITE_INVALID. + + + + +x + +Indicates the x-coordinate of the pointer in root window coordinates. + + + + +y + +Indicates the y-coordinate of the pointer in root window coordinates. + + + + +A pointer to the following structure is passed to callbacks for +XmNdropSiteLeaveCallback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; +}XmDropSiteLeaveCallbackStruct, *XmDropSiteLeaveCallback; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +timeStamp + +Specifies the timestamp of the logical event + + + + +A pointer to the following structure is passed for the +XmNdropStartCallback callback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + unsigned char operation; + unsigned char operations; + unsigned char dropSiteStatus; + unsigned char dropAction; + Position x; + Position y; +}XmDropStartCallbackStruct, *XmDropStartCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the time at which the drag was completed. + + + + +operation + +Identifies an operation. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes operation to the value of the operation +member of the XmDropProcCallbackStruct at the time the DropSite's +XmNdropProc returns. + +If the pointer is not over an active drop site when the drop begins, the +toolkit initializes operation by selecting an operation from the +initial value of the operations member. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If it finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + + + + +operations + +Indicates the set of operations supported for the source data. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes operations to the bitwise AND of the +DropSite's XmNdropOperations and the value of the operations +member of the XmDropProcCallbackStruct at the time the DropSite's +XmNdropProc returns. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +If the pointer is not over an active drop site when the drop begins and +if the user does not select an operation (by pressing a modifier key), +the toolkit initializes operations to the value of the +DragContext's XmNdragOperations resource. + +If the pointer is not over an active drop site when the drop begins and +if the user does select an operation, the toolkit initializes +operations to the bitwise AND of the corresponding operation and +the value of the DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + + + + +dropSiteStatus + +Indicates whether or not a drop site is valid. + +If the pointer is over an active drop site when the drop begins, the +toolkit initializes dropSiteStatus to the value of the +dropSiteStatus member of the XmDropProcCallbackStruct at the +time the DropSite's XmNdropProc returns. + +If the pointer is not over an active drop site when the drop begins, the +toolkit initializes dropSiteStatus to XmNO_DROP_SITE. + +This field is invalid if the dropAction field is set to +XmDROP_CANCEL. + + + + +dropAction + +An IN/OUT member that identifies the drop action. +The values are XmDROP, XmDROP_CANCEL, XmDROP_HELP, +and XmDROP_INTERRUPT. The value of dropAction can be +modified to change the action actually initiated. +The value XmDROP_INTERRUPT is currently unsupported; if +specified, it will be interpreted as an XmDROP_CANCEL. + + + + +x + +Indicates the x-coordinate of the pointer in root window coordinates. + + + + +y + +Indicates the y-coordinate of the pointer in root window coordinates. + + + + +A pointer to the following structure is passed to the +XmNoperationChangedCallback callback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + unsigned char operation; + unsigned char operations; + unsigned char dropSiteStatus; +}XmOperationChangedCallbackStruct, *XmOperationChangedCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the time at which the crossing event occurred. + + + + +operation + +Identifies an operation. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operation to the value of the operation +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. + +If the toolkit has not called an XmNdragProc, and the pointer is +within an active drop site, the toolkit initializes operation by +selecting an operation from the bitwise AND of the initial value of the +operations member and the value of the DropSite's +XmNdropSiteOperations resource. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + +If the toolkit has not called an XmNdragProc, and the pointer is +not within an active drop site, the toolkit initializes operation +by selecting an operation from the initial value of the operations +member. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + + + + +operations + +Indicates the set of operations supported for the source data. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes operations to the bitwise AND of the +DropSite's XmNdropOperations and the value of the operations +member of the XmDragProcCallbackStruct at the time the DropSite's +XmNdragProc returns. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +If the toolkit has not called an XmNdragProc, and the user does not +select an operation (by pressing a modifier key), the toolkit +initializes operations to the value of the DragContext's +XmNdragOperations resource. + +If the toolkit has not called an XmNdragProc, and the user does +select an operation, the toolkit initializes operations to the +bitwise AND of the corresponding operation and the value of the +DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + + + + +dropSiteStatus + +Indicates whether or not a drop site is valid. + +If the toolkit has just called a DropSite's XmNdragProc, the +toolkit initializes dropSiteStatus to the value of the +dropSiteStatus member of the XmDragProcCallbackStruct at the +time the DropSite's XmNdragProc returns. + +If the toolkit has not called an XmNdragProc it initializes +dropSiteStatus to XmNO_DROP_SITE if +the pointer is over an inactive drop site or is not over a drop site. +The toolkit initializes dropSiteStatus to XmDROP_SITE_VALID +if all the following conditions are met: + + + +The pointer is over an active drop site + + + +The DragContext's XmNexportTargets and the DropSite's +XmNimportTargets are compatible + + + +The initial value of the operation member is not +XmDROP_NOOP + + + +Otherwise, the toolkit initializes dropSiteStatus to +XmDROP_SITE_INVALID. + + + + +A pointer to the following structure is passed to callbacks for +XmNtopLevelEnterCallback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + Screen screen; + Window window; + Position x; + Position y; + unsigned char dragProtocolStyle; +}XmTopLevelEnterCallbackStruct, *XmTopLevelEnterCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the timestamp of the logical event. + + + + +screen + +Specifies the screen associated with the top-level window or root +window being entered. + + + + +window + +Specifies the ID of the top-level window or root window being entered. + + + + +x + +Indicates the x-coordinate of the pointer in root window coordinates. + + + + +y + +Indicates the y-coordinate of the pointer in root window coordinates. + + + + +dragProtocolStyle + +Specifies the protocol style adopted by the initiator. The values +are XmDRAG_DROP_ONLY, XmDRAG_DYNAMIC, XmDRAG_NONE, +and XmDRAG_PREREGISTER. + + + + +A pointer to the following structure is passed to callbacks for +XmNtopLevelLeaveCallback: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + Screen screen; + Window window; +}XmTopLevelLeaveCallbackStruct, *XmTopLevelLeaveCallback; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +timeStamp + +Specifies the timestamp of the logical event + + + + +screen + +Specifies a screen associated with the top-level window or root +window being left + + + + +window + +Specifies the ID of the top-level window or root window being left + + + + + + + +Translations +The XmDragContext translations are described in the following list. +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +Button1<Enter>: + +DragMotion() + + + + +Button1<Leave>: + +DragMotion() + + + + +Button1<Motion>: + +DragMotion() + + + + +Button2<Enter>: + +DragMotion() + + + + +Button2<Leave>: + +DragMotion() + + + + +Button2<Motion>: + +DragMotion() + + + + +Btn2Up: + +FinishDrag() + + + + +Btn1Up: + +FinishDrag() + + + + +KeyReturn: + +FinishDrag() + + + + +KeyosfActivate: + +FinishDrag() + + + + +BtnDown: + +IgnoreButtons() + + + + +BtnUp: + +IgnoreButtons() + + + + +:KeyosfCancel: + +CancelDrag() + + + + +:KeyosfHelp: + +HelpDrag() + + + + +:KeyosfUp: + +DragKey(Up) + + + + +:KeyosfDown: + +DragKey(Down) + + + + +:KeyosfLeft: + +DragKey(Left) + + + + +:KeyosfRight: + +DragKey(Right) + + + + +:<KeyUp>: + +DragKey(Update) + + + + +:<KeyDown>: + +DragKey(Update) + + + + + + + +Action Routines +The XmDragContext action routines are + + + +CancelDrag(): + +Cancels the drag operation and frees the associated +DragContext. + + + + +DragKey(String) + +If the value of String is Left, Right, Up, or +Down, this action +moves the dragged object in the corresponding location. Any other values of +String are ignored. + + + + +DragMotion(): + +Drags the selected data as the pointer is moved. + + + + +FinishDrag(): + +Finishes the drag operation and starts the drop operation. + + + + +HelpDrag(): + +Initiates a conditional drop that enables the receiver to provide +help information to the user. The user can cancel or continue the +drop operation in response to this information. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, +see &cdeman.VirtualBindings;. + + + + +RELATED INFORMATION +&cdeman.Core;, +&cdeman.XmDisplay;, +&cdeman.XmDragCancel;, +&cdeman.XmDragIcon;, +&cdeman.XmDragStart;, +&cdeman.XmDropSite;, +&cdeman.XmDropTransfer;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragIcon.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragIcon.sgm new file mode 100644 index 00000000..c0f28630 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragIcon.sgm @@ -0,0 +1,426 @@ + + + + + + + + + + + +XmDragIcon +library call + + +XmDragIcon +The DragIcon widget class + +XmDragIcon + +widget class +DragIcon + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DragDrop.h> + + + +DESCRIPTION +A DragIcon is a component of the visual used to represent the source +data in a drag and drop transaction. During a drag operation, a real +or simulated X cursor provides drag-over visuals consisting of a +static portion that represents the object being dragged, and dynamic +cues that provide visual feedback during the drag operation. The +visual is attained by blending together various XmDragIcons +specified in the XmDragContext associated with the drag +operation. + +The static portion of the drag-over visual is the graphic +representation that identifies the drag source. For example, +when a user drags several items within a list, a DragIcon depicting a +list might be supplied as the visual. The XmDragContext +resources, XmNsourceCursorIcon or XmNsourcePixmapIcon, +specify a DragIcon to use for the static portion of the visual. + +A drag-over visual incorporates dynamic cues in order to provide +visual feedback in response to the user's actions. For instance, +the drag-over visual might use different indicators to identify +the type of operation (copy, link, or move) being performed. Dynamic +cues could also alert the user that a drop site is valid or invalid +as the pointer traverses the drop site. The XmNoperationCursorIcon +and XmNstateCursorIcon resources of XmDragContext specify +DragIcons for dynamic cues. + +A drag-over visual typically consists of a source, operation and +state DragIcon. The XmNblendModel resource of XmDragContext +offers several options that determine which icons are blended +to produce the drag-over visual. DragIcon resources control +the relative position of the operation and state icons (if used). +If a particular DragIcon is not specified, the toolkit uses the +XmScreen default DragIcons. + +An application initializes a DragIcon with the function +XmCreateDragIcon or through entries in the resource +database. If a pixmap and its mask (optional) are specified +in the resource database, the toolkit converts the +values in the X11 Bitmap file format and assigns values to +the corresponding resources. + + +Classes +DragIcon inherits behavior and a resource from Object. + +The class pointer is xmDragIconObjectClass. + +The class name is XmDragIcon. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the +resource values for the inherited classes to set attributes for +this widget. To reference a resource by name or by class in +a .Xdefaults file, remove the XmN or XmC prefix and use +the remaining letters. To specify one of the defined values for a +resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include +any underscores between words). The codes in the access column +indicate if the given resource can be set at creation time (C), +set by using XtSetValues (S), retrieved by using +XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmDragIcon Resource Set + + +Name +Class +Type +Default +Access + + +XmNattachment +XmCAttachment +unsigned char +XmATTACH_NORTH_WEST +CSG + + +XmNdepth +XmCDepth +int +1 +CSG + + +XmNheight +XmCHeight +Dimension +0 +CSG + + +XmNhotX +XmCHot +Position +0 +CSG + + +XmNhotY +XmCHot +Position +0 +CSG + + + +XmNmask +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNoffsetX +XmCOffset +Position +0 +CSG + + +XmNoffsetY +XmCOffset +Position +0 +CSG + + +XmNpixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNwidth +XmCWidth +Dimension +0 +CSG + + + + + + +XmNattachment + +Specifies a relative location on the source icon for the attachment of +the state or operation icon. The origin of the state and operation +icons is aligned with the specified compass point on the source icon. +The XmNoffsetX and XmNoffsetY resources can be used to further +refine the icon positions. The possible values are + + + +XmATTACH_NORTH_WEST + +Attaches the origin of the state or operation icon to the northwest +point on the source icon. + + + + +XmATTACH_NORTH + +Attaches the origin of the state or operation icon to the north +point on the source icon. + + + + +XmATTACH_NORTH_EAST + +Attaches the origin of the state or operation icon to the northeast +point on the source icon. + + + + +XmATTACH_EAST + +Attaches the origin of the state or operation icon to the east +point on the source icon. + + + + +XmATTACH_SOUTH_EAST + +Attaches the origin of the state or operation icon to the southeast +point on the source icon. + + + + +XmATTACH_SOUTH + +Attaches the origin of the state or operation icon to the south +point on the source icon. + + + + +XmATTACH_SOUTH_WEST + +Attaches the origin of the state or operation icon to the southwest +point on the source icon. + + + + +XmATTACH_WEST + +Attaches the origin of the state or operation icon to the west +point on the source icon. + + + + +XmATTACH_CENTER + +Attaches the origin of the state or operation icon to the +center of the source icon. The XmNoffsetX and XmNoffsetY +resources may be used to center the attached icon. + + + + +XmATTACH_HOT + +Attaches the hotspot coordinates of a state or operation DragIcon to +an x,y position on the source icon. The x,y coordinate +is taken from the event passed to the XmDragStart function, +and made relative to the widget passed as an argument to the same +function. + + + + + + + +XmNdepth + +Specifies the depth of the pixmap. + + + + +XmNheight + +Specifies the height of the pixmap. + + + + +XmNhotX + +Specifies the x-coordinate of the hotspot of a cursor DragIcon +in relation to the origin of the pixmap bounding box. + + + + +XmNhotY + +Specifies the y-coordinate of the hotspot of a cursor DragIcon +in relation to the origin of the pixmap bounding box. + + + + +XmNmask + +Specifies a pixmap of depth 1 to use as the DragIcon mask +pixmap. + + + + +XmNoffsetX + +Specifies a horizontal offset (in pixels) of the origin of the state +or operation icon relative to the attachment point on the source icon. +A positive offset value moves the origin to the right; a negative value +moves the origin to the left. + + + + +XmNoffsetY + +Specifies a vertical offset (in pixels) of the origin of the state or +operation icon relative to the attachment point on the source icon. A +positive offset value moves the origin down; a negative value moves the +origin up. + + + + +XmNpixmap + +Specifies a pixmap to use as the DragIcon pixmap. + + + + +XmNwidth + +Specifies the width of the pixmap. + + + + + + +Inherited Resources +DragIcon inherits behavior and a resource from Object. +For a complete description of this resource, refer to the +Object reference page. + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + +RELATED INFORMATION +&cdeman.Object;, +&cdeman.XmCreateDragIcon;, +&cdeman.XmDisplay;, +&cdeman.XmDragContext;, +&cdeman.XmDropSite;, +&cdeman.XmDropTransfer;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragSt.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragSt.sgm new file mode 100644 index 00000000..654022b1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DragSt.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmDragStart +library call + + +XmDragStart +A Drag and Drop function that initiates a drag and +drop transaction + +XmDragStart + +Drag and Drop functions +XmDragStart + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +Widget XmDragStart + +Widget widget +XEvent *event +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmDragStart initiates a drag operation. This routine +returns the DragContext widget that it initializes for the +associated drag transaction. The toolkit is responsible for +freeing the DragContext when the drag and drop transaction +is complete. + + + +widget + +Specifies the ID of the smallest widget and/or gadget that encloses +the source elements selected for a drag operation. + + + + +event + +Specifies the XEvent that triggered the drag operation. This +event must be a ButtonPress event. + + + + +arglist + +Specifies the argument list. Any XmDragContext resources not +specified in the argument list are obtained from the resource database +or are set to their default values. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist) + + + + +For a complete definition of DragContext and its associated resources, +see &cdeman.XmDragContext;. + + + +RETURN +Returns the ID of the DragContext widget that controls this drag +and drop transaction. +Returns NULL if the drag cannot be initiated. + + + +RELATED +&cdeman.XmDragCancel; and +&cdeman.XmDragContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawAr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawAr.sgm new file mode 100644 index 00000000..22cd4fe8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawAr.sgm @@ -0,0 +1,1178 @@ + + + + + + + + + + + +XmDrawingArea +library call + + +XmDrawingArea +The DrawingArea widget class + +XmDrawingArea + +widget class +DrawingArea + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DrawingA.h> + + + +DESCRIPTION +DrawingArea is an empty widget that is easily adaptable +to a variety of purposes. +It does no drawing and defines no behavior except for invoking +callbacks. +Callbacks notify the application when graphics need to be drawn +(exposure events or widget resize) and when the widget receives input from +the keyboard or mouse. + +Applications are responsible for defining appearance and behavior as needed +in response to DrawingArea callbacks. + +DrawingArea is also a composite widget and subclass of +XmManager that supports +minimal geometry management for multiple widget or gadget children. + +DrawingArea uses the XmNinitialFocus resource of XmManager +to define whether or not DrawingArea will receive focus when it is +traversed to, even if it has traversable children. If +XmNinitialFocus is NULL, DrawingArea receives focus only if it +does not have any traversable children. If XmNinitialFocus is +not NULL, then DrawingArea receives focus when traversed to. In the latter +case, the application first needs to be able to realize that the DrawingArea +will receive focus, then, as appropriate, needs to either call the +XmProcessTraversal function for the desired child, or to navigate +across the private DrawingArea graphics objects. + +The following resources are not currently used by the DrawingArea +widget: XmNshadowThickness, XmNtopShadowPixmap, +XmNbottomShadowPixmap, XmNtopShadowColor, and +XmNbottomShadowColor + + +Data Transfer Behavior +DrawingArea has no widget class conversion or destination procedure. +Subclasses and the XmNconvertCallback procedures are responsible +for any conversion of selections. +Subclasses and the XmNdestinationCallback procedures are +responsible for any data transfers to the widget. + + + +Classes +DrawingArea inherits behavior and resources from the Core, +Composite, Constraint, and XmManager classes. + +The class pointer is xmDrawingAreaWidgetClass. + +The class name is XmDrawingArea. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmDrawingArea Resource Set + + +Name +Class +Type +Default +Access + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdestinationCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNexposeCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNinputCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNresizeCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + + + + + +XmNconvertCallback + +Specifies a list of callbacks called when the DrawingArea is asked to +convert a selection. +The type of the structure whose address is passed to these callbacks is +XmConvertCallbackStruct. +The reason is XmCR_OK. + + + + +XmNdestinationCallback + +Specifies a list of callbacks called when the DrawingArea is the +destination of a transfer operation. +The type of the structure whose address is passed to these callbacks is +XmDestinationCallbackStruct. +The reason is XmCR_OK. + + + + +XmNexposeCallback + +Specifies the list of callbacks that is +called when DrawingArea receives an exposure event. +The callback reason is XmCR_EXPOSE. +The callback structure also includes the exposure event. + +The default bit gravity for Manager windows is NorthWestGravity. +This may cause the XmNexposeCallback procedures not to be invoked +when the DrawingArea window is made smaller. + + + + +XmNinputCallback + +Specifies the list of callbacks that is +called when the DrawingArea receives a keyboard +or mouse event (key or button, up or down). +The callback reason is XmCR_INPUT. +The callback structure also includes the input event. + + + + +XmNmarginHeight + +Specifies the minimum spacing in pixels between the top or bottom edge +of DrawingArea and any child widget. + + + + +XmNmarginWidth + +Specifies the minimum spacing in pixels between the left or right edge +of DrawingArea and any child widget. + + + + +XmNresizeCallback + +Specifies the list of callbacks that is +called when the DrawingArea is resized. +The callback reason is XmCR_RESIZE. + + + + +XmNresizePolicy + +Controls the policy for resizing DrawingArea widgets. +Possible values include XmRESIZE_NONE (fixed size), +XmRESIZE_ANY (shrink or grow as needed), and +XmRESIZE_GROW (grow only). + + + + + + +Inherited Resources +DrawingArea inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to the +XmNexposeCallback, XmNinputCallback, and +XmNresizeCallback procedures: + +typedef struct +{ + int reason; + XEvent * event; + Window window; +} XmDrawingAreaCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +This is NULL for the XmNresizeCallback. + + + + +window + +Is set to the widget window. + + + + +A pointer to the following structure is passed to the +XmNconvertCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + Atom target; + XtPointer source_data; + XtPointer location_data; + int flags; + XtPointer parm; + int parm_format; + unsigned long parm_length; + int status; + XtPointer value; + Atom type; + int format; + unsigned long length; +} XmConvertCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which conversion is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, +and _MOTIF_DROP. + + + + +target + +Indicates the conversion target. + + + + +source_data + +Contains information about the selection source. +When the selection is _MOTIF_DROP, source_data is the +DragContext. +Otherwise, it is NULL. + + + + +location_data + +Contains information about the location of data to be converted. +If the value is NULL, the data to be transferred consists of the +widget's current selection. + + + + +flags + +Indicates the status of the conversion. Following are the possible +values: + + + +XmCONVERTING_NONE + +This flag is currently unused. + + + + +XmCONVERTING_PARTIAL + +The target widget was able to be converted, but some data was lost. + + + + +XmCONVERTING_SAME + +The conversion target is the source of the data to be transferred. + + + + +XmCONVERTING_TRANSACT + +This flag is currently unused. + + + + + + + +parm + +Contains parameter data for this target. +If no parameter data exists, the value is NULL. + +When selection is CLIPBOARD and target is +_MOTIF_CLIPBOARD_TARGETS or +_MOTIF_DEFERRED_CLIPBOARD_TARGETS, the value is the requested +operation (XmCOPY, XmMOVE, or XmLINK). + + + + +parm_format + +Specifies whether the data in parm should be viewed +as a list of char, short, or long quantities. +Possible values are 0 (when parm is NULL), +8 (when the data in parm should be viewed as a list of chars), +16 (when the data in parm should be viewed as a list of shorts), +or 32 (when the data in parm should be viewed as a list of longs). +Note that parm_format symbolizes a data type, not the number of bits +in each list element. +For example, on some machines, a parm_format of 32 means that +the data in parm should be viewed as a list of 64-bit quantities, +not 32-bit quantities. + + + + +parm_length + +Specifies the number of elements of data in parm, where each +element has the size specified by parm_format. +When parm is NULL, the value is 0. + + + + +status + +An IN/OUT member that specifies the status of the conversion. +The initial value is XmCONVERT_DEFAULT. +The callback procedure can set this member to one of the following +values: + + + +XmCONVERT_DEFAULT + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it +overwrites the data provided by the callback procedures in the value +member. + + + + +XmCONVERT_MERGE + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it appends +its data to the data provided by the callback procedures in the +value member. +This value is intended for use with targets that result in lists of +data, such as TARGETS. + + + + +XmCONVERT_DONE + +This value means that the callback procedure has successfully finished +the conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + +XmCONVERT_REFUSE + +This value means that the callback procedure has terminated the +conversion process without completing the requested conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + + + + +value + +An IN/OUT parameter that contains any data that the callback procedure +produces as a result of the conversion. +The initial value is NULL. +If the callback procedure sets this member, it must ensure that the +type, format, and length members correspond +to the data in value. +The callback procedure is responsible for allocating, but not for +freeing, memory when it sets this member. + + + + +type + +An IN/OUT parameter that indicates the type of the data in the +value member. +The initial value is INTEGER. + + + + +format + +An IN/OUT parameter that specifies whether the data in value should +be viewed as a list of char, short, or long quantities. +The initial value is 8. +The callback procedure can set this member to 8 (for a list of char), +16 (for a list of short), or 32 (for a list of long). + + + + +length + +An IN/OUT member that specifies the number of elements of data in +value, where each element has the size symbolized by format. +The initial value is 0. + + + + +A pointer to the following callback structure is passed to the +XmNdestinationCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + XtEnum operation; + int flags; + XtPointer transfer_id; + XtPointer destination_data; + XtPointer location_data; + Time time; +} XmDestinationCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which data transfer is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, and +_MOTIF_DROP. + + + + +operation + +Indicates the type of transfer operation requested. + + + +When the selection is PRIMARY, possible values are XmMOVE, +XmCOPY, and XmLINK. + + + +When the selection is SECONDARY or CLIPBOARD, possible +values are XmCOPY and XmLINK. + + + +When the selection is _MOTIF_DROP, possible values are +XmMOVE, XmCOPY, XmLINK, and XmOTHER. +A value of XmOTHER means that the callback procedure must get +further information from the XmDropProcCallbackStruct in the +destination_data member. + + + + + + +flags + +Indicates whether or not the destination widget is also the source of +the data to be transferred. +Following are the possible values: + + + +XmCONVERTING_NONE + +The destination widget is not the source of the data to be transferred. + + + + +XmCONVERTING_SAME + +The destination widget is the source of the data to be transferred. + + + + + + + +transfer_id + +Serves as a unique ID to identify the transfer transaction. + + + + +destination_data + +Contains information about the destination. +When the selection is _MOTIF_DROP, the callback procedures are +called by the drop site's XmNdropProc, and destination_data +is a pointer to the XmDropProcCallbackStruct passed to the +XmNdropProc procedure. +When the selection is SECONDARY, destination_data is an Atom +representing a target recommmended by the selection owner for use in +converting the selection. +Otherwise, destination_data is NULL. + + + + +location_data + +Contains information about the location where data is to be transferred. +The value is always NULL when the selection is SECONDARY or +CLIPBOARD. +If the value is NULL, the data is to be inserted at the widget's cursor +position. location_data is only valid for the duration of a +transfer. Once XmTransferDone procedures start to be called, +location_data will no longer be stable. + + + + +time + +Indicates the time when the transfer operation began. + + + + + + + + + + + + + + + + +Translations +XmDrawingArea inherits translations from XmManager. +Before calling the XmManager actions, all events in the inherited +translations except BtnMotion, EnterWindow, +LeaveWindow, FocusIn, and FocusOut also call the +DrawingAreaInput() action. + +XmDrawingArea has the following additional translations. +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +BtnDown: + +DrawingAreaInput() + + + + +BtnUp: + +DrawingAreaInput() + + + + +KeyDown: + +DrawingAreaInput() +ManagerGadgetKeyInput() + + + + +KeyUp: + +DrawingAreaInput() + + + + + + + +Action Routines +The XmDrawingArea action routines are + + + +DrawingAreaInput(): + +Unless the event takes place in a gadget, calls the callbacks for +XmNinputCallback + + + + +ManagerGadgetKeyInput(): + +Causes the current gadget to process a keyboard event + + + + + + +Additional Behavior +The XmDrawingArea widget has the following additional behavior: + + + +Expose: + +Calls the callbacks for XmNexposeCallback + + + + +Widget Resize: + +Calls the callbacks for XmNresizeCallback + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, +&cdeman.XmCreateDrawingArea;, +and &cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawnBut.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawnBut.sgm new file mode 100644 index 00000000..3f0d48cf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DrawnBut.sgm @@ -0,0 +1,1081 @@ + + + + + + + + + + + +XmDrawnButton +library call + + +XmDrawnButton +The DrawnButton widget class + +XmDrawnButton + +widget class +DrawnButton + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DrawnB.h> + + + +DESCRIPTION +The DrawnButton widget consists of an empty widget window surrounded by a +shadow border. It provides the application developer with a graphics area +that can have PushButton input semantics. + +Callback types are defined for widget exposure and widget resize to allow the +application to redraw or reposition its graphics. If the DrawnButton +widget has a highlight and shadow thickness, the application should not draw +in that area. +To avoid drawing in the highlight and +shadow area, create the graphics context with +a clipping rectangle for drawing in the widget. +The clipping rectangle should +take into account the size of the widget's highlight thickness and +shadow. +DrawnButton uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits, and +holds the XmQTactivatable trait. + + +Classes +BulletinBoard inherits behavior, resources, and traits +from the Core, Composite, Constraint, +and XmManager classes. + +The class pointer is xmDrawnButtonWidgetClass. + +The class name is XmDrawnButton. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmDrawnButton Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdisarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNexposeCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmultiClick +XmCMultiClick +unsigned char +dynamic +CSG + + +XmNpushButtonEnabled +XmCPushButtonEnabled +Boolean +False +CSG + + +XmNresizeCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_ETCHED_IN +CSG + + + + + + +XmNactivateCallback + +Specifies the list of callbacks that is called +when the widget becomes selected. +The reason sent by the callback is XmCR_ACTIVATE. +This callback uses the XmQTactivatable trait. + + + + +XmNarmCallback + +Specifies the list of callbacks that is called +when the widget becomes armed. +The reason sent by the callback is XmCR_ARM. + + + + +XmNdisarmCallback + +Specifies the list of callbacks that is called +when the widget becomes disarmed. +The reason sent by the callback is XmCR_DISARM. + + + + +XmNexposeCallback + +Specifies the list of callbacks that is called +when the widget receives an exposure event. +The reason sent by the callback is XmCR_EXPOSE. + + + + +XmNmultiClick + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, and this resource is +set to XmMULTICLICK_DISCARD, the second click is not processed. +If this resource is set to XmMULTICLICK_KEEP, the event +is processed and click_count is incremented in the callback structure. +When the button is not in a menu, the default value is +XmMULTICLICK_KEEP. + + + + +XmNpushButtonEnabled + +Enables or disables the 3-dimensional shadow drawing as in +PushButton. + + + + +XmNresizeCallback + +Specifies the list of callbacks that is called +when the widget receives a resize event. +The reason sent by the callback is XmCR_RESIZE. The event +returned for this callback is NULL. + + + + +XmNshadowType + +Describes the drawing style for the DrawnButton. This resource can have +the following values: + + + +XmSHADOW_IN + +Draws the DrawnButton so that the shadow appears +inset. This means that the bottom shadow visuals and top shadow visuals +are reversed. + + + + +XmSHADOW_OUT + +Draws the DrawnButton +so that the shadow appears outset. + + + + +XmSHADOW_ETCHED_IN + +Draws the DrawnButton using a double line. This +gives the effect of a line etched into the window. The thickness of the +double line is equal to the value of XmNshadowThickness. + + + + +XmSHADOW_ETCHED_OUT + +Draws the DrawnButton using a double line. This +gives the effect of a line coming out of the window. The thickness of the +double line is equal to the value of XmNshadowThickness. + + + + + + + + + +Inherited Resources +DrawnButton inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabel Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +N/A + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +N/A + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +"\0" +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +0 +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +0 +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +0 +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +0 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +N/A + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +N/A + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + Window window; + int click_count; +} XmDrawnButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +This is NULL for XmNresizeCallback. + + + + +window + +Is set to the window ID in which the event occurred. + + + + +click_count + +Contains the number of clicks in the last multiclick sequence +if the XmNmultiClick resource is set to XmMULTICLICK_KEEP, +otherwise it contains 1. +The activate callback is invoked for each click if XmNmultiClick +is set to XmMULTICLICK_KEEP. + + + + + + + + + + + + + + + + +Translations +XmDrawnButton includes translations from Primitive. +Additional XmDrawnButton translations are +described in the following list. +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +c<Btn1Down>: + +ButtonTakeFocus() + + + + +≈cBtn1Down: + +Arm() + + + + +≈cBtn1Down,≈cBtn1Up: + +Activate() Disarm() + + + + +≈cBtn1Down(2+): + +MultiArm() + + + + +≈cBtn1Up(2+): + +MultiActivate() + + + + +≈cBtn1Up: + +Activate() Disarm() + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfHelp: + +Help() + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + + + +Action Routines +The XmDrawnButton action routines are + + + +Activate(): + +If XmNpushButtonEnabled is True, redraws the shadow in the +unselected state; otherwise, redraws the shadow according to +XmNshadowType. +If the pointer is within the DrawnButton, calls the +XmNactivateCallback callbacks. + + + + +Arm(): + +If XmNpushButtonEnabled is True, redraws the shadow in the +selected state; otherwise, redraws the shadow according to +XmNshadowType. +Calls the callbacks for XmNarmCallback. + + + + +ArmAndActivate(): + +If XmNpushButtonEnabled is True, redraws the shadow in the +selected state; otherwise, redraws the shadow according to +XmNshadowType. +Calls the callbacks for XmNarmCallback. + +If XmNpushButtonEnabled is True, the shadow is redrawn in the +unselected state; otherwise, the shadow is redrawn according to +XmNshadowType. +The callbacks for XmNactivateCallback and XmNdisarmCallback +are called. +These actions happen either immediately or at a later +time. + + + + +ButtonTakeFocus(): + +Causes the PushButton to take keyboard focus +when Ctrl<Btn1Down> is pressed, without activating the widget. + + + + +Disarm(): + +Marks the DrawnButton as unselected and calls the callbacks for +XmNdisarmCallback. + + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +MultiActivate(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +increments click_count in the callback structure. +If XmNpushButtonEnabled is True, this action redraws the shadow in the +unselected state; otherwise, it redraws the shadow according to +XmNshadowType. +If the pointer is within the DrawnButton, this action calls the +XmNactivateCallback callbacks and calls the +callbacks for XmNdisarmCallback. + + + + +MultiArm(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP and +if XmNpushButtonEnabled is True, this action +redraws the shadow in the selected state; +otherwise, it redraws the shadow according to +XmNshadowType and +calls the callbacks for XmNarmCallback. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +EnterWindow: + +Draws the shadow in its selected state if XmNpushButtonEnabled is +True and if the cursor leaves and re-enters the window while BSelect is +pressed. + + + + +LeaveWindow: + +Draws the shadow in its unselected state if XmNpushButtonEnabled +is True and if the cursor leaves the window while BSelect is pressed. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, XmCreateDrawnButton, &cdeman.XmLabel;, +&cdeman.XmPrimitive;, XmPushButton, and &cdeman.XmSeparator;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSit.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSit.sgm new file mode 100644 index 00000000..81ec565c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSit.sgm @@ -0,0 +1,789 @@ + + + + + + + + + + + +XmDropSite +library call + + +XmDropSite +The DropSite Registry + +XmDropSite + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DragDrop.h> + + + +DESCRIPTION +A client registers a widget or gadget as a drop site using the +XmDropSiteRegister function. In addition, this routine +defines the behavior and capabilities of a drop site by specifying +appropriate resources. For example, the XmNimportTargets +and XmNnumImportTargets resources identify respectively the +selection target types and number of types supported by a drop +site. The visual animation effects associated with +a drop site are also described with DropSite resources. + +Drop site animation effects that occur in response to the pointer +entering a valid drop site are called drag-under effects. A receiver +can select from several animation styles supplied by the toolkit or +can provide customized animation effects. Drag-under effects supplied +by the toolkit include border highlighting, shadow in/out drawing, +and pixmap representation. + +When a preregister drag protocol style is used, the toolkit generates +drag-under visual effects based on the value of the XmNanimationStyle +resource. In dynamic mode, if the drop site XmNdragProc +resource is NULL, the toolkit also provides animation effects based on +the XmNanimationStyle resource. Otherwise, if the XmNdragProc +routine is specified, the receiver can either assume +responsibility for animation effects (through the XmNdragProc routine) +or rely on the toolkit to provide animation. +An application can either handle all or none of the animation effects +for a particular drop site. +That is, an application should never do a partial job of animation +on a particular drop site. + +Drop sites may overlap. The initial stacking order corresponds to the +order in which the drop sites were registered. When a drop site +overlaps another drop site, the drag-under effects of the +drop site underneath are clipped by the obscuring drop site(s). + +The XmDropSiteUpdate routine sets resources for a widget +that is registered as a drop site. XmDropSiteRetrieve gets drop +site resource values previously specified for a registered widget. These +routines are used instead of XtSetValues and XtGetValues. + + +Classes +XmDropSite does not inherit from any widget class. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. To reference a resource by name +or by class in a .Xdefaults file, remove the XmN or XmC +prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix +and use the remaining letters (in either lowercase or uppercase, but include +any underscores between words). The codes in the access column +indicate if the given resource can be set at creation time (C), +set by using XmDropSiteUpdate (S), retrieved by using +XmDropSiteRetrieve (G), or is not applicable (N/A). + + + + + + + + + + + +XmDropSite Resource Set + + +Name +Class +Type +Default +Access + + +XmNanimationMask +XmCAnimationMask +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNanimationPixmap +XmCAnimationPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNanimationPixmapDepth +XmCAnimationPixmapDepth +int +0 +CSG + + +XmNanimationStyle +XmCAnimationStyle +unsigned char +XmDRAG_UNDER_HIGHLIGHT +CSG + + +XmNdragProc +XmCDragProc +XtCallbackProc +NULL +CSG + + +XmNdropProc +XmCDropProc +XtCallbackProc +NULL +CSG + + +XmNdropRectangles +XmCDropRectangles +XRectangle * +dynamic +CSG + + +XmNdropSiteActivity +XmCDropSiteActivity +unsigned char +XmDROP_SITE_ACTIVE +CSG + + +XmNdropSiteOperations +XmCDropSiteOperations +unsigned char +XmDROP_MOVE | XmDROP_COPY +CSG + + +XmNdropSiteType +XmCDropSiteType +unsigned char +XmDROP_SITE_SIMPLE +CG + + +XmNimportTargets +XmCImportTargets +Atom * +NULL +CSG + + +XmNnumDropRectangles +XmCNumDropRectangles +Cardinal +1 +CSG + + +XmNnumImportTargets +XmCNumImportTargets +Cardinal +0 +CSG + + + + + + +XmNanimationMask + +Specifies a mask to use with the pixmap specified +by XmNanimationPixmap when the animation style is +XmDRAG_UNDER_PIXMAP. + + + + +XmNanimationPixmap + +Specifies a pixmap for drag-under animation when the +animation style is XmDRAG_UNDER_PIXMAP. The pixmap +is drawn with its origin at the upper left corner of the +bounding box of the drop site. If the drop site window +is larger than the animation pixmap, the portion of the +window not covered by the pixmap will be tiled with the +window's background color. + + + + +XmNanimationPixmapDepth + +Specifies the depth of the pixmap specified by the +XmNanimationPixmap resource. When the depth is 1, the +colors are taken from the foreground and background of the +drop site widget. For any other value, drop site animation +occurs only if the XmNanimationPixmapDepth matches the +depth of the drop site window. Colors are derived from the +current colormap. + + + + +XmNanimationStyle + +Specifies the drag-under animation style used when a drag enters +a valid drop site. The possible values are + + + +XmDRAG_UNDER_HIGHLIGHT + +The drop site uses highlighting effects. + + + + +XmDRAG_UNDER_SHADOW_OUT + +The drop site uses an outset shadow. + + + + +XmDRAG_UNDER_SHADOW_IN + +The drop site uses an inset shadow. + + + + +XmDRAG_UNDER_PIXMAP + +The drop site uses the pixmap specified by XmNanimationPixmap +to indicate that it can receive the drop. + + + + +XmDRAG_UNDER_NONE + +The drop site does not use animation effects. A client +using a dynamic protocol, may provide drag-under +effects in its XmNdragProc routine. + + + + + + + +XmNdragProc + +Specifies the procedure that is invoked when the drop site +receives a crossing, motion, or operation changed message. This +procedure is called only when a dynamic protocol is used. +The type of structure whose address is passed to this +procedure is XmDragProcCallbackStruct. +The reason sent to the procedure is one of +the following: + + + +XmCR_DROP_SITE_ENTER_MESSAGE + + + +XmCR_DROP_SITE_LEAVE_MESSAGE + + + +XmCR_DRAG_MOTION + + + +XmCR_OPERATION_CHANGED + + + +The drag procedure may change the values of some members of the +XmDragProcCallbackStruct passed to it. +After the drag procedure returns, the toolkit uses the final values in +initializing some members of the callback structure passed to the +appropriate callbacks of the initiator (the DragContext's +XmNdropSiteEnterCallback, XmNdropSiteLeaveCallback, +XmNdragMotionCallback, or XmNoperationChangedCallback +callbacks). + + + + +XmNdropProc + +Specifies the procedure that is invoked when a drop +(excluding a cancel or interrupt action) occurs +on a drop site regardless of the status of the drop site. The +type of the structure whose address is passed to this procedure +is XmDropProcCallbackStruct. The reason +sent to the procedure is XmCR_DROP_MESSAGE. + +The drop procedure may change the values of some members of the +XmDropProcCallbackStruct passed to it. +After the drop procedure returns, the toolkit uses the final values in +initializing some members of the XmDropStartCallbackStruct passed +to the initiator's drop start callbacks (the DragContext's +XmNdropStartCallback callbacks). + + + + +XmNdropRectangles + +Specifies a list of rectangles that describe the shape of a +drop site. The locations of the rectangles are relative to the +origin of the enclosing object. When XmNdropRectangles +is NULL, +the drop site is assumed to be the sensitive area of +the enclosing widget. If XmNdropSiteType is +XmDROP_SITE_COMPOSITE, this resource cannot be specified by +the application. + +Retrieving this resource returns allocated memory that needs to be +freed with the XtFree function. + + + + +XmNdropSiteActivity + +Indicates whether a drop site is active or inactive. The values +are XmDROP_SITE_ACTIVE, XmDROP_SITE_INACTIVE, and +XmDROP_SITE_IGNORE. +An +active drop site can receive a drop, whereas an inactive drop +site is dormant. An inactive drop site is treated as if it was +not a registered drop site and any drag-under visuals associated +with entering or leaving the drop site do not occur. However, it +is still used for clipping drag-under effects. +A value of XmDROP_SITE_IGNORE indicates that a drop site should +be ignored for all purposes. + + + + +XmNdropSiteOperations + +Specifies the set of valid operations associated with a drop site. +This resource is a bit mask that is formed by combining one or +more of the following values using a bitwise operation such as +inclusive OR (|): +XmDROP_COPY, XmDROP_LINK, and XmDROP_MOVE. +The value XmDROP_NOOP for this resource indicates that no +operations are valid. + + + + +XmNdropSiteType + +Specifies the type of the drop site. The possible values are + + + +XmDROP_SITE_SIMPLE + +The widget does not have any additional children that +are registered as drop sites. + + + + +XmDROP_SITE_COMPOSITE + +The widget will have children that are registered as drop +sites. + + + + + + + +XmNimportTargets + +Specifies the list of target atoms that this drop site accepts. + + + + +XmNnumDropRectangles + +Specifies the number of rectangles in the XmNdropRectangles +list. If the drop site type is XmDROP_SITE_COMPOSITE, this resource +can not be specified by the application. + + + + +XmNnumImportTargets + +Specifies the number of atoms in the target atom list. + + + + + + +Callback Information +A pointer to the following structure is passed to the +XmNdragProc routine when the drop site receives +crossing, motion, or operation changed messages: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + Widget dragContext; + Position x; + Position y; + unsigned char dropSiteStatus; + unsigned char operation; + unsigned char operations; + Boolean animate; +} XmDragProcCallbackStruct, *XmDragProcCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the timestamp of the logical event. + + + + +dragContext + +Specifies the ID of the DragContext widget associated with +the transaction. + + + + +x + +Indicates the x-coordinate of the pointer relative +to the drop site. + + + + +y + +Indicates the y-coordinate of the pointer relative +to the drop site. + + + + +dropSiteStatus + +An IN/OUT member that indicates whether or not a drop site is valid. + +When reason is XmCR_DROP_SITE_ENTER_MESSAGE or +XmCR_OPERATION_CHANGED, +or +reason is +XmCR_DRAG_MOTION +or XmCR_DROP_SITE_LEAVE_MESSAGE and +the pointer is not in the same drop site as on the previous invocation +of the drag procedure, +the toolkit initializes dropSiteStatus to XmDROP_SITE_VALID +if the DragContext's XmNexportTargets and the DropSite's +XmNimportTargets are compatible and if the initial value of the +operation member is not XmDROP_NOOP. +Otherwise, the toolkit initializes dropSiteStatus to +XmDROP_SITE_INVALID. + +When the reason is +XmCR_DRAG_MOTION +or +XmCR_DROP_SITE_LEAVE_MESSAGE and the pointer is within the same +drop site as on the previous invocation of the drag procedure, the +toolkit initializes dropSiteStatus to the value of +dropSiteStatus at the time the previous invocation of the drag +procedure returns. + +The drag procedure may change the value of this member. +After the drag procedure returns, the toolkit uses the final value in +initializing the dropSiteStatus member of the callback struct +passed to the appropriate callbacks of the initiator. + + + + +operation + +An IN/OUT member that identifies an operation. + +The toolkit initializes operation by selecting an operation +from the bitwise AND of the initial value of the operations member +and the value of the DropSite's XmNdropSiteOperations resource. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If the toolkit finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + +The drag procedure may change the value of this member. +After the drag procedure returns, the toolkit uses the final value in +initializing the operation member of the callback struct +passed to the appropriate callbacks of the initiator. + + + + +operations + +An IN/OUT member that indicates the set of operations supported for the +source data. + +If the user does not select an operation (by pressing a modifier key), +the toolkit initializes operations to the value of the +DragContext's XmNdragOperations resource. +If the user does select an operation, the toolkit initializes +operations to the bitwise AND of the corresponding operation and +the value of the DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +The drag procedure may change the value of this member. +After the drag procedure returns, the toolkit uses the final value in +initializing the operations member of the callback struct +passed to the appropriate callbacks of the initiator. + + + + +animate + +An OUT member that indicates whether the toolkit or +the receiver client provides drag-under effects for a valid +drop site. If animate is set to True, the toolkit provides +drop site animation per the XmNanimationStyle +resource value; if it is set to False, +the receiver generates drag-under animation effects. + + + + +A pointer to the following structure is passed to the XmNdropProc +routine when the drop site receives a drop message: + +typedef struct +{ + int reason; + XEvent *event; + Time timeStamp; + Widget dragContext; + Position x; + Position y; + unsigned char dropSiteStatus; + unsigned char operation; + unsigned char operations; + unsigned char dropAction; +} XmDropProcCallbackStruct, *XmDropProcCallback; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Specifies the XEvent that triggered the callback. + + + + +timeStamp + +Specifies the timestamp of the logical event. + + + + +dragContext + +Specifies the ID of the DragContext widget associated with the +transaction. + + + + +x + +Indicates the x-coordinate of the pointer relative to the +drop site. + + + + +y + +Indicates the y-coordinate of the pointer relative to the +drop site. + + + + +dropSiteStatus + +An IN/OUT member that indicates whether or not a drop site is valid. + +The toolkit initializes dropSiteStatus to XmDROP_SITE_VALID +if the DragContext's XmNexportTargets and the DropSite's +XmNimportTargets are compatible and if the initial value of the +operation member is not XmDROP_NOOP. +Otherwise, the toolkit initializes dropSiteStatus to +XmDROP_SITE_INVALID. + +The drop procedure may change the value of this member. +After the drop procedure returns, the toolkit uses the final value in +initializing the dropSiteStatus member of the +XmDropStartCallbackStruct passed to the initiator's drop start +callbacks (the DragContext's XmNdropStartCallback callbacks). + + + + +operation + +An IN/OUT member that identifies an operation. + +The toolkit initializes operation by selecting an operation +from the bitwise AND of the initial value of the operations member +and the value of the DropSite's XmNdropSiteOperations resource. +The toolkit searches this set first for XmDROP_MOVE, then for +XmDROP_COPY, then for XmDROP_LINK, and initializes +operation to the first operation it finds in the set. +If it finds none of these operations in the set, it initializes +operation to XmDROP_NOOP. + +The drop procedure may change the value of this member. +After the drop procedure returns, the toolkit uses the final value in +initializing the operation member of the +XmDropStartCallbackStruct passed to the initiator's drop start +callbacks (the DragContext's XmNdropStartCallback callbacks). + + + + +operations + +An IN/OUT member that indicates the set of operations supported for the +source data. + +If the user does not select an operation (by pressing a modifier key), +the toolkit initializes operations to the value of the +DragContext's XmNdragOperations resource. +If the user does select an operation, the toolkit initializes +operations to the bitwise AND of the corresponding operation and +the value of the DragContext's XmNdragOperations resource. +If the resulting set of operations is empty, the toolkit initializes +operations to XmDROP_NOOP. + +The drop procedure may change the value of this member. +After the drop procedure returns, the toolkit uses the final value in +initializing the operations member of the +XmDropStartCallbackStruct passed to the initiator's drop start +callbacks (the DragContext's XmNdropStartCallback callbacks). + + + + +dropAction + +An IN/OUT member that identifies the action associated with the drop. +The possible values are + + + +XmDROP + +A drop was attempted. If the drop site is valid, drop transfer +handling proceeds. + + + + +XmDROP_HELP + +The user has requested help on the drop site. + + + + +The drop procedure may change the value of this member. +After the drop procedure returns, the toolkit uses the final value in +initializing the dropAction member of the +XmDropStartCallbackStruct passed to the initiator's drop start +callbacks (the DragContext's XmNdropStartCallback callbacks). + + + + + + + +RELATED INFORMATION +&cdeman.XmDragContext;, +&cdeman.XmDragIcon;, +&cdeman.XmDropSiteConfigureStackingOrder;, +&cdeman.XmDropSiteEndUpdate;, +&cdeman.XmDropSiteQueryStackingOrder;, +&cdeman.XmDropSiteRegister;, +&cdeman.XmDropSiteStartUpdate;, +&cdeman.XmDropSiteUpdate;, +&cdeman.XmDropSiteUnregister;, +&cdeman.XmDropTransfer;, and +&cdeman.XmTargetsAreCompatible;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitC.sgm new file mode 100644 index 00000000..d511ee0b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitC.sgm @@ -0,0 +1,143 @@ + + + + + + + + + + + +XmDropSiteConfigureStackingOrder +library call + + +XmDropSiteConfigureStackingOrder +A Drag and Drop function that +reorders a stack of widgets that are registered drop sites + +XmDropSiteConfigureStack\\%ingOrder + +Drag and Drop functions +XmDropSiteConfigureStack\\%ingOrder + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteConfigureStackingOrder + +Widget widget +Widget sibling +Cardinal stack_mode + + + +DESCRIPTION +XmDropSiteConfigureStackingOrder changes the stacking +order of the drop site specified by widget. The stacking +order controls the manner in which drag-under effects are +clipped by overlapping siblings, regardless of whether they are +active. The stack mode is relative either to the entire stack, +or to another drop site within the stack. The stack order can +be modified only if the drop +sites are siblings in both the widget and drop site hierarchy, and +the widget parent of the drop sites is registered +as a composite drop site. + + + +widget + +Specifies the drop site to be restacked. + + + + +sibling + +Specifies a sibling drop site for stacking operations. If specified, +then widget is restacked relative to this drop site's stack position. + + + + +stack_mode + +Specifies the new stack position for the specified widget. +The values are XmABOVE and XmBELOW. If a sibling is specified, +then widget is restacked as follows: + + + +XmABOVE + +The widget is placed just above the sibling. + + + + +XmBELOW + +The widget is placed just below the sibling. + + + + +If the sibling parameter is not specified, then widget +is restacked as follows: + + + +XmABOVE + +The widget is placed at the top of the stack. + + + + +XmBELOW + +The widget is placed at the bottom of the stack. + + + + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSite;, +&cdeman.XmDropSiteRetrieve;, and +&cdeman.XmDropSiteQueryStackingOrder;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitE.sgm new file mode 100644 index 00000000..cf0d755f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitE.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmDropSiteEndUpdate +library call + + +XmDropSiteEndUpdate +A Drag and Drop function that facilitates +processing updates to multiple drop sites + +XmDropSiteEndUpdate + +Drag and Drop functions +XmDropSiteEndUpdate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteEndUpdate + +Widget widget + + + +DESCRIPTION +XmDropSiteEndUpdate is used in conjunction with +XmDropSiteStartUpdate to process updates to +multiple drop sites within the same hierarchy. XmDropSiteStartUpdate +and XmDropSiteEndUpdate signal the beginning and +the end respectively of a series of calls to XmDropSiteUpdate. +Calls to XmDropSiteStartUpdate and XmDropSiteEndUpdate can +be recursively stacked. Using these routines optimizes the processing +of update information. + + + +widget + +Specifies the ID of any widget within a given hierarchy. The function +uses this widget to identify the shell that contains the drop sites. + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSiteStartUpdate; and +&cdeman.XmDropSiteUpdate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitQ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitQ.sgm new file mode 100644 index 00000000..57b14e5d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitQ.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmDropSiteQueryStackingOrder +library call + + +XmDropSiteQueryStackingOrder +A Drag and Drop function that +returns the parent, a list of children, and the number of children +for a specified widget + +XmDropSiteQueryStacking\\%Order + +Drag and Drop functions +XmDropSiteQueryStacking\\%Order + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +Status XmDropSiteQueryStackingOrder + +Widget widget +Widget *parent_return +Widget **child_returns +Cardinal *num_child_returns + + + +DESCRIPTION +XmDropSiteQueryStackingOrder obtains the parent, a list of +children registered as drop sites, and the number of children registered +as drop sites for a given widget. The children are listed in current +stacking order, from bottom-most (first child) to the top-most (last +child). +This function allocates memory for the returned data that +must be freed by calling XtFree. + + + +widget + +Specifies the widget ID. For this widget, you obtain the list +of its children, its parent, and the number of children. + + + + +parent_return + +Returns the widget ID of the drop site parent of the +specified widget. + + + + +child_returns + +Returns a pointer to the list of drop site children associated with +the specified widget. +The function allocates memory to hold the list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XtFree. + + + + +num_child_returns + +Returns the number of drop site children for the specified widget. + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RETURN +Returns 0 (zero) if the routine fails; returns a nonzero +value if it succeeds. + + + +RELATED +&cdeman.XmDropSite; and +&cdeman.XmDropSiteConfigureStackingOrder;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitT.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitT.sgm new file mode 100644 index 00000000..88dfbc04 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitT.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmDropSiteRegister +library call + + +XmDropSiteRegister +A Drag and Drop function that identifies +a drop site and assigns resources that specify its behavior + +XmDropSiteRegister + +Drag and Drop functions +XmDropSiteRegister + +register functions +XmDropSiteRegister + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteRegister + +Widget widget +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmDropSiteRegister identifies the specified widget or +gadget as a drop site and sets resource values that define +the drop site's behavior. The routine assigns default values +to any resources that are not specified in the argument list. +The toolkit generates a warning message if a drop site is +registered with XmNdropSiteActivity set to +XmDROP_SITE_ACTIVE and the XmNdropProc resource +is NULL. + +If the drop site is a descendant of a widget that is registered +as a drop site, the XmNdropSiteType resource of the ancestor +drop site must be specified as XmDROP_SITE_COMPOSITE. The +ancestor must be registered before the descendant. The drop site +is stacked above all other sibling drop sites already registered. + + + +widget + +Specifies the ID of the widget to be registered. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist). + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDisplay;, +&cdeman.XmDropSite;, +&cdeman.XmDropSiteEndUpdate;, +&cdeman.XmDropSiteStartUpdate;, +&cdeman.XmDropSiteUpdate;, +&cdeman.XmDropSiteUnregister;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitU.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitU.sgm new file mode 100644 index 00000000..788f2c2d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitU.sgm @@ -0,0 +1,80 @@ + + + + + + + + + + + +XmDropSiteRegistered +library call + + +XmDropSiteRegistered +A Drag and Drop function that determines if a drop site has been registered + +XmDropSiteRegistered + +Drag and Drop functions +XmDropSiteRegistered + +register functions +XmDropSiteRegistered + + + + + + + + + + +#include <Xm/DragDrop.h> + +Boolean XmDropSiteRegistered + +Widget widget + + + +DESCRIPTION +XmDropSiteRegistered determines if the specified widget has a +drop site registered. If a drop site is registered, this function returns +True. + + + +widget + +Specifies the ID of the widget being queried. + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RETURN +If the widget is not a registered drop site, this function returns +False. Otherwise, it returns True. + + + +RELATED +&cdeman.XmDisplay;, +&cdeman.XmDropSite;, +&cdeman.XmDropSiteEndUpdate;, +&cdeman.XmDropSiteStartUpdate;, +&cdeman.XmDropSiteUpdate;, +&cdeman.XmDropSiteUnregister;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitV.sgm new file mode 100644 index 00000000..741ae1b8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitV.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmDropSiteRetrieve +library call + + +XmDropSiteRetrieve +A Drag and Drop function that retrieves +resource values set on a drop site + +XmDropSiteRetrieve + +Drag and Drop functions +XmDropSiteRetrieve + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteRetrieve + +Widget widget +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmDropSiteRetrieve extracts values for the given +resources from the drop site specified by widget. +An initiator can also obtain information about the current drop +site by passing the associated DragContext widget as the widget +parameter to this routine. The initiator can retrieve all +of the drop site resources except XmNdragProc and +XmNdropProc using this method. + + + +widget + +Specifies the ID of the widget that encloses the drop site. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist). + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSite; and +&cdeman.XmDropSiteUpdate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitW.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitW.sgm new file mode 100644 index 00000000..dc56928d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitW.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmDropSiteStartUpdate +library call + + +XmDropSiteStartUpdate +A Drag and Drop function that +facilitates processing updates to multiple drop sites + +XmDropSiteStartUpdate + +Drag and Drop functions +XmDropSiteStartUpdate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteStartUpdate + +Widget widget + + + +DESCRIPTION +XmDropSiteStartUpdate is used in conjunction with +XmDropSiteEndUpdate to process updates to multiple +drop sites within the same shell widget. XmDropSiteStartUpdate +and XmDropSiteEndUpdate signal the beginning and the end +respectively of a series of calls to XmDropSiteUpdate. Calls to +XmDropSiteStartUpdate and XmDropSiteEndUpdate can be +recursively stacked. Using these routines optimizes the processing +of update information. + + + +widget + +Specifies the ID of any widget within a given hierarchy. The function +uses this widget to identify the shell that contains the drop sites. + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSite;, +&cdeman.XmDropSiteEndUpdate;, and +&cdeman.XmDropSiteUpdate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitX.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitX.sgm new file mode 100644 index 00000000..8106c710 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitX.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +XmDropSiteUnregister +library call + + +XmDropSiteUnregister +A Drag and Drop function that +frees drop site information + +XmDropSiteUnregister + +Drag and Drop functions +XmDropSiteUnregister + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteUnregister + +Widget widget + + + +DESCRIPTION +XmDropSiteUnregister informs the toolkit that the specified +widget is no longer a registered drop site. The function frees all +associated drop site information. + + + +widget + +Specifies the ID of the widget, registered as a drop site, +that is to be unregistered + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSite; and +&cdeman.XmDropSiteRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitY.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitY.sgm new file mode 100644 index 00000000..528a8f38 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropSitY.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmDropSiteUpdate +library call + + +XmDropSiteUpdate +A Drag and Drop function that sets +resource values for a drop site + +XmDropSiteUpdate + +Drag and Drop functions +XmDropSiteUpdate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropSiteUpdate + +Widget widget +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmDropSiteUpdate modifies drop site resources associated with +the specified widget. This routine updates the drop site resources +specified in the arglist. + + + +widget + +Specifies the ID of the widget registered as a drop site + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist) + + + + +For a complete definition of DropSite and its associated resources, +see &cdeman.XmDropSite;. + + + +RELATED +&cdeman.XmDropSite;, +&cdeman.XmDropSiteEndUpdate;, +&cdeman.XmDropSiteRegister;, +&cdeman.XmDropSiteStartUpdate;, and +&cdeman.XmDropSiteUnregister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrA.sgm new file mode 100644 index 00000000..f7eb173a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrA.sgm @@ -0,0 +1,308 @@ + + + + + + + + + + + +XmDropTransfer +library call + + +XmDropTransfer +The DropTransfer widget class + +XmDropSite + +widget class +DropTransfer + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/DragDrop.h> + + + +DESCRIPTION +DropTransfer provides a set of resources that identifies +the procedures and associated information required by the +toolkit in order to process and complete a drop transaction. +Clients should not explicitly create a DropTransfer widget. +Instead, a client initiates a transfer by calling +XmDropTransferStart, which initializes and returns a +DropTransfer widget. If this function is called within an +XmNdropProc callback, the actual transfers are initiated +after the callback returns. Even if no data needs to be transferred, +XmDropTransferStart needs to be called (typically with +no arguments, or just setting XmNtransferStatus) to finish +the drag and drop transaction. + +The XmNdropTransfers resource specifies a transfer +list that describes the requested target types for the source +data. A transfer list is an array of XmDropTransferEntryRec +structures, each of which identifies a target type. The +transfer list is analogous to the MULTIPLE selections capability +defined in the Inter-Client Communication Conventions Manual +(ICCCM). + +The DropTransfer resource, XmNtransferProc, specifies a +transfer procedure of type XtSelectionCallbackProc that +delivers the requested selection data. This procedure operates +in conjunction with the underlying Xt selection capabilities and +is called for each target in the transfer list. Additional target +types can be requested after a transfer is initiated by calling +the XmDropTransferAdd function. + + +Structures +An XmDropTransferEntry is a pointer to the following structure of +type XmDropTransferEntryRec, which identifies a selection +target associated with a given drop transaction: + +typedef struct +{ + XtPointer client_data; + Atom target; +} XmDropTransferEntryRec, *XmDropTransferEntry; + + +client_data + +Specifies any additional information required +by this selection target + + + + +target + +Specifies a selection target associated with the drop +operation + + + + + + +Classes +DropTransfer inherits behavior and a resource from Object. + +The class pointer is xmDropTransferObjectClass. + +The class name is XmDropTransfer. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the +resource values for the inherited classes to set attributes for +this widget. To reference a resource by name or by class in +a .Xdefaults file, remove the XmN or XmC prefix and use +the remaining letters. To specify one of the defined values for a +resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include +any underscores between words). The codes in the access column +indicate if the given resource can be set at creation time (C), +set by using XtSetValues (S), retrieved by using +XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmDropTransfer Resource Set + + +Name +Class +Type +Default +Access + + +XmNdropTransfers +XmCDropTransfers +XmDropTransferEntryRec * +NULL +CG + + +XmNincremental +XmCIncremental +Boolean +False +CSG + + +XmNnumDropTransfers +XmCNumDropTransfers +Cardinal +0 +CSG + + +XmNtransferProc +XmCTransferProc +XtSelectionCallbackProc +NULL +CSG + + +XmNtransferStatus +XmCTransferStatus +unsigned char +XmTRANSFER_SUCCESS +CSG + + + + + + +XmNdropTransfers + +Specifies the address of an array of drop transfer entry records. The +drop transfer is complete when all the entries in the list have been +processed. + + + + +XmNincremental + +Specifies a Boolean value that indicates whether the transfer on the +receiver side uses the Xt incremental selection transfer mechanism +described in X Toolkit Intrinsics—C Language Interface. +If the value is True, the receiver uses incremental transfer; if the +value is False, the receiver uses atomic transfer. + + + + +XmNnumDropTransfers + +Specifies the number of entries in XmNdropTransfers. If +this resource is set to 0 at any time, the transfer is considered +complete. The value of XmNtransferStatus determines the +completion handshaking process. + + + + +XmNtransferProc + +Specifies a procedure of type XtSelectionCallbackProc that +delivers the requested selection values. +The widget argument passed to this procedure is the DropTransfer +widget. +The selection atom passed is _MOTIF_DROP. +For additional information on selection callback procedures, see X +Toolkit Intrinsics—C Language Interface. + + + + +XmNtransferStatus + +Specifies the current status of the drop transfer. The client +updates this value when the transfer ends and communicates +the value to the initiator. The possible values are + + + +XmTRANSFER_SUCCESS + +The transfer succeeded. + + + + +XmTRANSFER_FAILURE + +The transfer failed. + + + + + + + + + +Inherited Resources +DropTransfer inherits behavior and a resource from Object. +For a complete description of this resource, refer +to the Object reference page. + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + +RELATED INFORMATION +&cdeman.Object;, +&cdeman.XmDisplay;, +&cdeman.XmDragContext;, +&cdeman.XmDragIcon;, +&cdeman.XmDropSite;, +&cdeman.XmDropTransferAdd;, and +&cdeman.XmDropTransferStart;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrB.sgm new file mode 100644 index 00000000..caea688d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrB.sgm @@ -0,0 +1,100 @@ + + + + + + + + + + + +XmDropTransferAdd +library call + + +XmDropTransferAdd +A Drag and Drop function that enables +additional drop transfer entries to be processed after initiating +a drop transfer + +XmDropTransferAdd + +Drag and Drop functions +XmDropTransferAdd + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +void XmDropTransferAdd + +Widget drop_transfer +XmDropTransferEntryRec *transfers +Cardinal num_transfers + + + +DESCRIPTION +XmDropTransferAdd identifies a list of additional drop transfer +entries to be processed after a drop transfer is started. + + + +drop_transfer + +Specifies the ID of the DropTransfer widget returned by +XmDropTransferStart + + + + +transfers + +Specifies the additional drop transfer entries that the receiver +wants processed + + + + +num_transfers + +Specifies the number of items in the transfers array + + + + +For a complete definition of DropTransfer and its associated resources, +see &cdeman.XmDropTransfer;. + + + +RELATED +&cdeman.XmDragContext;, +&cdeman.XmDropTransfer;, and +&cdeman.XmDropTransferStart;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrC.sgm new file mode 100644 index 00000000..3d838d9a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/DropTrC.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmDropTransferStart +library call + + +XmDropTransferStart +A Drag and Drop function that initiates a +drop transfer + +XmDropTransferStart + +Drag and Drop functions +XmDropTransferStart + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +Widget XmDropTransferStart + +Widget widget +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmDropTransferStart initiates a drop transfer and uses the +specified argument list to initialize an XmDropTransfer object. +The DropTransfer object can be manipulated with XtSetValues +and XtGetValues until the last call to the XmNtransferProc +procedure is made. After that point, the result of using the +widget pointer is undefined. The DropTransfer object is freed +by the toolkit when a transfer is complete. + + + +widget + +Specifies the ID of the DragContext widget associated with the +transaction + + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument +list (arglist) + + + + +For a complete definition of DropTransfer and its associated resources, +see &cdeman.XmDropTransfer;. + + + +RETURN +Returns the ID of the DropTransfer widget. + + + +RELATED +&cdeman.XmDragContext;, +&cdeman.XmDropTransfer;, and +&cdeman.XmDropTransferAdd;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelA.sgm new file mode 100644 index 00000000..4a3dcebf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelA.sgm @@ -0,0 +1,2192 @@ + + + + + + + + + + + +XmFileSelectionBox +library call + + +XmFileSelectionBox +The FileSelectionBox widget class + +XmFileSelectionBox + +widget class +FileSelectionBox + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/FileSB.h> + + + +DESCRIPTION +FileSelectionBox traverses +through directories, views the files and subdirectories in them, +and then selects files. + +A FileSelectionBox has five main areas: + + + +A text input field for displaying and editing a directory mask used to +select the files to be displayed + + + +An optional text input field for displaying and editing a filter mask +used to select the files to be displayed. + + + +A scrollable list of filenames + + + +A scrollable list of subdirectories + + + +A text input field for displaying and editing a filename + + + +A group of PushButtons, +labeled OK, Filter, Cancel, and Help. +The layout direction of the buttons depends on the +XmNlayoutDirection resource. + + + +####Additional children may be added to the FileSelectionBox after +creation. +FileSelectionBox inherits the layout functionality provided +by SelectionBox for any additional children. +To remove the list of filenames, the list of subdirectories, or both +from the FileSelectionBox after creation, unmanage the +appropriate widgets and their labels. +The list and label widgets are obtained through a call to the +XmFileSelectionBoxGetChild function. +To remove either the directory list or the file list, unmanage the +parent of the appropriate list widget and unmanage the corresponding +label. + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of FileSelectionBox. The following list +identifies the names of these widgets (or gadgets) and the associated +FileSelectionBox areas: + + + +FilterLabel + +FilterText + + + + +Filter Text + +TextField + + + +Directory List + +DirList + + + + +Directory List Label + +Dir + + + + +DirL + +Label + + + + +DirText + +TextField + + + + +The directory mask is a string specifying the base directory to be +examined and a search pattern. +Ordinarily, the directory list displays the subdirectories of the base +directory, as well as the base directory itself and its parent +directory. +The file list ordinarily displays all files and/or subdirectories in the +base directory that match the search pattern. + +Optionally, the search pattern mask and the base directory can be +displayed in two separate text fields. This option is controlled by +the XmNpathMode resource. Using this alternate +display does not change the meaning of resources that control the +content of these fields: XmNdirectory, XmNdirMask, +XmNpattern. + +A procedure specified by the XmNqualifySearchDataProc resource +extracts the base directory and search pattern from the directory mask. +If the directory specification is empty, the current working directory +is used. +If the search pattern is empty, a pattern that matches all files is +used. + +An application can supply its own XmNqualifySearchDataProc as well +as its own procedures to search for subdirectories and files. +The default XmNqualifySearchDataProc works as follows: +The directory mask is a pathname that can contain zero or more +wildcard characters in its directory portion, its file portion, or +both. +The directory components of the directory mask — up to, but not +including, the first component with a wildcard character — specify the +directory to be searched, relative to the current working directory. +The remaining components specify the search pattern. +If the directory mask is empty or if its first component contains a +wildcard character, the current working directory is searched. +If no component of the directory mask contains a wildcard character, the +entire directory mask is the directory specification, and all files in +that directory are matched. + +The user can select a new directory to examine by scrolling through the +list of directories and selecting the desired directory or by editing +the directory mask. +Selecting a new directory from the directory list does not change the +search pattern. +A user can select a new search pattern by editing the directory mask +or, when the FileSelectionBox has the optional XmNpathMode +XmPATH_MODE_RELATIVE display, the filter text field. +Double clicking or pressing KActivate on a directory in the +directory list initiates a search for files and subdirectories in the +new directory, using the current search pattern. + +The user can select a file by scrolling through the list of filenames +and selecting the desired file or by entering the filename directly into +the text edit area. +Selecting a file from the list causes that filename to appear in the +file selection text edit area. + +The user may select a new file as many times as desired. +The application is not notified until the user takes one of the +following actions: + + + +Selects the OK PushButton + + + +Presses KActivate while the selection text edit area has the +keyboard focus + + + +Double clicks or presses KActivate on an item in the file list + + + +FileSelectionBox initiates a directory and file search when any of the +following occurs: + + + +The FileSelectionBox is initialized + + + +The function XtSetValues is used to change XmNdirMask, +XmNdirectory, XmNpattern, or XmNfileTypeMask + + + +The user activates the Filter PushButton + + + +The user double clicks or presses KActivate on an item in the +directory list + + + +The application calls XmFileSelectionDoSearch + + + +The user presses KActivate while the directory mask text edit area +has the keyboard focus + + + +When a file search is initiated, the FileSelectionBox takes the +following actions: + + + +Constructs an XmFileSelectionBoxCallbackStruct structure with +values appropriate for the action that initiated the search + + + +Calls the XmNqualifySearchDataProc with the callback structure as +the data input argument + + + +Sets XmNdirectoryValid and XmNlistUpdated to False + + + +Calls the XmNdirSearchProc with the qualified data returned by the +XmNqualifySearchDataProc + + + +If XmNdirectoryValid is True, the FileSelectionBox takes the +following additional actions: + + + +Sets XmNlistUpdated to False + + + +Calls the XmNfileSearchProc with the qualified data returned by +the XmNqualifySearchDataProc (and possibly modified by the +XmNdirSearchProc) + + + +If XmNlistUpdated is True and the file list is empty, displays the +XmNnoMatchString in the file list and clears the selection text +and XmNdirSpec + + + +If XmNlistUpdated is True and the file list is not empty, sets the +selection text and XmNdirSpec to the qualified dir returned +by the XmNqualifySearchDataProc (and possibly modified by the +XmNdirSearchProc) + + + +Sets the directory mask text and XmNdirMask to the qualified +mask returned by the XmNqualifySearchDataProc (and possibly +modified by the XmNdirSearchProc) + + + +Sets XmNdirectory to the qualified dir returned by the +XmNqualifySearchDataProc (and possibly modified by the +XmNdirSearchProc) + + + +Sets XmNpattern to the qualified pattern returned by the +XmNqualifySearchDataProc (and possibly modified by the +XmNdirSearchProc) + + + +FileSelectionBox uses the XmQTactivatable trait. + + +Data Transfer Behavior +Child widgets of a FileSelectionBox support the data transfer operations +and targets associated with their widget classes. + +In addition, if the source of a data transfer is the directory list and +if XmNdirSearchProc has its default value, the directory list +supports the FILE and FILE_NAME targets. + +If the source of a data transfer is the file list and if +XmNfileSearchProc has its default value, the file list supports +the FILE and FILE_NAME targets. + +In either case, FileSelectionBox adds an XmNconvertCallback +procedure to the appropriate list. +This procedure adds FILE and FILE_NAME to the TARGETS +returned by the list. +It treats requests for conversion of a selection to FILE and +FILE_NAME exactly like requests for conversion to TEXT. + +If an application changes XmNdirSearchProc or +XmNfileSearchProc and wants to support the FILE and +FILE_NAME targets on the corresponding list, it must provide +support itself by adding a procedure to the list's +XmNconvertCallback list. + + + +Descendants +FileSelectionBox automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +Apply +XmPushButtonGadget +Apply button + + +Cancel +XmPushButtonGadget +Cancel button + + +Dir +XmLabelGadget +title above list of directories + + +DirList +XmList +list of directories + + +DirListSW +XmScrolledWindow +ScrolledWindow parent of DirList + + +FilterLabel +XmLabelGadget +title above filter box + + +FilterText +XmText or XmTextField +text within filter box + + +Help +XmPushButtonGadget +Help button + + +Items +XmLabelGadget +title above list of filenames + + +ItemsList +XmList +list of filenames + + +ItemsListSW +XmScrolledWindow +ScrolledWindow parent of ItemsList + + +OK +XmPushButtonGadget +OK button + + +Selection +XmLabelGadget +title above selection box + + +Separator +XmSeparatorGadget +optional dividing line + + +Text +XmText or XmTextField +text within selection box + + + + + + +Classes +FileSelectionBox inherits behavior, +resources, and traits from Core, Composite, +Constraint, XmManager, +XmBulletinBoard, and XmSelectionBox. + +The class pointer is xmFileSelectionBoxWidgetClass. + +The class name is XmFileSelectionBox. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmFileSelectionBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNdirectory +XmCDirectory +XmString +dynamic +CSG + + +XmNdirectoryValid +XmCDirectoryValid +Boolean +dynamic +SG + + +XmNdirListItems +XmCDirListItems +XmStringTable +dynamic +SG + + +XmNdirListItemCount +XmCDirListItemCount +int +dynamic +SG + + +XmNdirListLabelString +XmCDirListLabelString +XmString +dynamic +CSG + + +XmNdirMask +XmCDirMask +XmString +dynamic +CSG + + +XmNdirSearchProc +XmCDirSearchProc +XmSearchProc +default procedure +CSG + + +XmNdirSpec +XmCDirSpec +XmString +dynamic +CSG + + +XmNdirTextLabelString +XmCDirTextLabelString +XmString +NULL +C + + +XmNfileFilterStyle +XmCFileFilterStyle +XtEnum +XmFILTER_NONE +C + + +XmNfileListItems +XmCItems +XmStringTable +dynamic +SG + + +XmNfileListItemCount +XmCItemCount +int +dynamic +SG + + +XmNfileListLabelString +XmCFileListLabelString +XmString +dynamic +CSG + + +XmNfileSearchProc +XmCFileSearchProc +XmSearchProc +default procedure +CSG + + +XmNfileTypeMask +XmCFileTypeMask +unsigned char +XmFILE_REGULAR +CSG + + +XmNfilterLabelString +XmCFilterLabelString +XmString +dynamic +CSG + + +XmNlistUpdated +XmCListUpdated +Boolean +dynamic +SG + + +XmNnoMatchString +XmCNoMatchString +XmString +" [    ] " +CSG + + +XmNpathMode +XmCPathMode +XtEnum +XmPATH_MODE_FULL +C + + +XmNpattern +XmCPattern +XmString +dynamic +CSG + + +XmNqualifySearchDataProc +XmCQualifySearchDataProc +XmQualifyProc +default procedure +CSG + + + + + + +XmNdirectory + +Specifies the base directory used in combination with XmNpattern +in determining the files and directories to be displayed. +The default value is determined by the XmNqualifySearchDataProc +and depends on the initial values of XmNdirMask, +XmNdirectory, and XmNpattern. +If the default is NULL or empty, the current working directory is used. + + + + +XmNdirectoryValid + +Specifies an attribute that is set only by the directory search +procedure. +The value is set to True if the directory passed to the directory search +procedure can actually be searched. +If this value is False the file search procedure is not called, and +XmNdirMask, XmNdirectory, and XmNpattern are not +changed. + + + + +XmNdirListItems + +Specifies the items in the directory list. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items. + + + + +XmNdirListItemCount + +Specifies the number of items in the directory list. +The value must not be negative. + + + + +XmNdirListLabelString + +Specifies the label string of the directory list. +The default for this resource depends on the locale. +In the C locale the default is Directories. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNdirMask + +Specifies the directory mask used +in determining the files and directories to be displayed. +The default value is determined by the +XmNqualifySearchDataProc +and depends on the initial values of XmNdirMask, +XmNdirectory, and XmNpattern. + + + + +XmNdirSearchProc + +Specifies a directory search procedure to replace the default +directory search procedure. +FileSelectionBox's default directory search procedure fulfills the needs +of most applications. +Because it is impossible to cover the requirements of all applications, +you can replace the default search procedure. + +The directory search procedure is called with two arguments: +the FileSelectionBox widget and a pointer to an +XmFileSelectionBoxCallbackStruct structure. +The callback structure is generated by the +XmNqualifySearchDataProc and contains all information required to +conduct a directory search, including the directory mask and a qualified +base directory and search pattern. +Once called, it is up to the search routine to generate a new list of +directories and update the FileSelectionBox widget by using +XtSetValues. + +The search procedure must set XmNdirectoryValid and +XmNlistUpdated. +If it generates a new list of directories, it must also set +XmNdirListItems and XmNdirListItemCount. + +If the search procedure cannot search the specified directory, it must +warn the user and set XmNdirectoryValid and XmNlistUpdated +to False, unless it prompts and subsequently obtains a valid directory. +If the directory is valid but is the same as the current +XmNdirectory, the search procedure must set +XmNdirectoryValid to True, but it may elect not to generate a new +list of directories. +In this case, it must set XmNlistUpdated to False. + +If the search procedure generates a new list of directories, it must set +XmNdirListItems to the new list of directories and +XmNdirListItemCount to the number of items in the list. +If there are no directories, it sets XmNdirListItems to NULL and +XmNdirListItemCount to 0 (zero). +In either case, it must set XmNdirectoryValid and +XmNlistUpdated to True. + +The search procedure ordinarily should not change the callback structure. +But if the original directory is not valid, the search procedure may +obtain a new directory from the user. +In this case, it should set the dir member of the callback structure +to the new directory, +call the XmNqualifySearchDataProc with the +callback struct as the input argument, and copy the qualified data +returned by the XmNqualifySearchDataProc into the callback struct. + + + + +XmNdirSpec + +Specifies the full file path specification. +This is the XmNtextString resource in SelectionBox, renamed for +FileSelectionBox. +The default value is determined by the FileSelectionBox after conducting +the initial directory and file search. + + + + +XmNdirTextLabelString + +Uses the specified XmString as the label above the TextField +directory. The resource takes effect when the XmNpathMode +resource has a value of XmPATH_MODE_RELATIVE. It is ignored +when the XmNpathMode resource has a value of XmPATH_MODE_FULL. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNfileFilterStyle + +Specifies whether or not the "hidden" files (those whose names begin +with . (period) in POSIX systems) will be listed in the file and +directory +scrolling lists (where the default directory search procedure is used). +The possible values are: + + + +XmFILTER_NONE + +Does not filter hidden files. + + + + +XmFILTER_HIDDEN_FILES + +Restricts the list of possible file names, such as those beginning +with . (period). + + + + + + + +XmNfileListItems + +Specifies the items in the file list. +This is the XmNlistItems resource in SelectionBox, renamed for +FileSelectionBox. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items. + + + + +XmNfileListItemCount + +Specifies the number of items in the file list. +This is the XmNlistItemCount resource in SelectionBox, renamed for +FileSelectionBox. +The value must not be negative. + + + + +XmNfileListLabelString + +Specifies the label string of the file list. +This is the XmNlistLabelString resource in SelectionBox, renamed +for FileSelectionBox. +The default for this resource depends on the locale. +In the C locale the default is Files. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNfileSearchProc + +Specifies a file search procedure to replace the default file search +procedure. +FileSelectionBox's default file search procedure fulfills the needs of +most applications. +Because it is impossible to cover the requirements of all applications, +you can replace the default search procedure. + +The file search procedure is called with two arguments: +the FileSelectionBox widget and a pointer to an +XmFileSelectionBoxCallbackStruct structure. +The callback structure is generated by the +XmNqualifySearchDataProc (and possibly modified by the +XmNdirSearchProc). +It contains all information required to conduct a file search, including +the directory mask and a qualified base directory and search pattern. +Once this procedure is called, +it is up to the search routine to generate a new list of +files and update the FileSelectionBox widget by using XtSetValues. + +The search procedure must set XmNlistUpdated. +If it generates a new list of files, it must also set +XmNfileListItems and XmNfileListItemCount. + +It is recommended that the search procedure always generate a new list of +files. +If the mask member of the callback structure is the same as the +mask member of the callback struct in the preceding call to the +search procedure, the procedure may elect not to generate a new list of +files. +In this case it must set XmNlistUpdated to False. + +If the search procedure generates a new list of files, it must set +XmNfileListItems to the new list of files and +XmNfileListItemCount to the number of items in the list. +If there are no files, it sets XmNfileListItems to NULL and +XmNfileListItemCount to 0 (zero). +In either case it must set XmNlistUpdated to True. + +In constructing the list of files, the search procedure should include +only files of the types specified by the widget's XmNfileTypeMask. + +Setting XmNdirSpec is optional, but recommended. +Set this attribute to the full file specification of the directory +searched. +The directory specification is displayed below the directory and file +lists. + + + + +XmNfileTypeMask + +Specifies the type of files listed in the file list. +The possible values are + + + +XmFILE_REGULAR + +Restricts the file list to contain only regular +files. + + + + +XmFILE_DIRECTORY + +Restricts the file list to contain only +directories. + + + + +XmFILE_ANY_TYPE + +Allows the list to contain all file types +including directories. + + + + + + + +XmNfilterLabelString + +Specifies the label string for the text entry field for the directory +mask. +The default for this resource depends on the locale. +In the C locale the default is Filter. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNlistUpdated + +Specifies an attribute that is set only by the directory and file search +procedures. +This resource is set to True if the +search procedure updated the directory or file list. + + + + +XmNnoMatchString + +Specifies a string to be displayed in the file list if the list of files +is empty. + + + + +XmNpattern + +Specifies the search pattern used in combination with XmNdirectory +in determining the files and directories to be displayed. +The default value is determined by XmNqualifySearchDataProc +and depends on the initial values of XmNdirMask, +XmNdirectory, and XmNpattern. +If the default is NULL or empty, a pattern that matches all files is +used. + + + + +XmNpathMode + +Specifies whether or not an additional text field will be used to +display and edit the filter. The possible values are + + + +XmPATH_MODE_FULL + +Specifies that no additional text field will be used to display +the filter. There will just be a single text field to display +XmNdirMask. + + + + +XmPATH_MODE_RELATIVE + +Specifies that there will be two text field displays, one to display +the XmNdirectory and one to display the XmNpattern. In +this instance, the XmNfilterLabelString resource applies to the +text field for +XmNpattern and XmNdirTextLabelString applies to the text +field for XmNdirectory. + + + + + + + +XmNqualifySearchDataProc + +Specifies a search data qualification procedure to replace the default +data qualification procedure. +FileSelectionBox's default data qualification procedure fulfills the +needs of most applications. +Because it is impossible to cover the requirements of all applications, +you can replace the default procedure. + +The data qualification procedure is called to generate a qualified +directory mask, base directory, and search pattern for use by the +directory and file search procedures. +It is called with three arguments: +the FileSelectionBox widget and pointers to two +XmFileSelectionBoxCallbackStruct structures. +The first callback structure contains the input data. +The second callback structure contains the output data, to be filled in by +the data qualification procedure. + +If the input dir and pattern members are not NULL, the +procedure must copy them to the corresponding members of the output +callback structure. + +If the input dir is NULL, the procedure constructs the +output dir as follows: +If the input mask member is NULL, the procedure uses the +widget's XmNdirectory as the output dir; otherwise, it +extracts the output dir from the input mask. +If the resulting output dir is empty, the procedure uses +the current working directory instead. + +If the input pattern is NULL, the procedure constructs +the output pattern as follows: +If the input mask member is NULL, the procedure uses the +widget's XmNpattern as the output pattern; otherwise, it +extracts the output pattern from the input mask. +If the resulting output pattern is empty, the procedure +uses a pattern that matches all files instead. + +The data qualification procedure constructs the output mask from +the output dir and pattern. +The procedure must ensure that the output dir, pattern, and +mask are fully qualified. + +If the input value member is not NULL, the procedure must copy it +to the output value member; otherwise, the procedure must copy the +widget's XmNdirSpec to the output value. + +The data qualification procedure must calculate the lengths of the +output value, mask, dir, and pattern members and +must fill in the corresponding length members of the output callback +struct. + +The data qualification procedure must copy the input reason and +event members to the corresponding output members. + + + + +The values of the XmNdirSearchProc and XmNfileSearchProc +are procedure pointers of type XmSearchProc, defined as +follows: + +void (* XmSearchProc) (w, search_data) + Widget w; + XtPointer search_data; + + +w + +The FileSelectionBox widget + + + + +search_data + +Pointer to an XmFileSelectionBoxCallbackStruct containing +information for conducting a search + + + + +The value of the XmNqualifySearchDataProc resource +is a procedure pointer of type XmQualifyProc, defined +as follows: + +void (* XmQualifyProc) (w, input_data, output_data) + Widget w; + XtPointer input_data; + XtPointer output_data; + + +w + +The FileSelectionBox widget + + + + +input_data + +Pointer to an XmFileSelectionBoxCallbackStruct containing +input data to be qualified + + + + +output_data + +Pointer to an XmFileSelectionBoxCallbackStruct containing +output data to be filled in by the qualification procedure + + + + + + +Inherited Resources +FileSelectionBox inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmSelectionBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNapplyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNapplyLabelString +XmCApplyLabelString +XmString +dynamic +CSG + + +XmNcancelCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcancelLabelString +XmCCancelLabelString +XmString +dynamic +CSG + + +XmNchildPlacement +XmCChildPlacement +unsigned char +XmPLACE_ABOVE_SELECTION +CSG + + +XmNdialogType +XmCDialogType +unsigned char +XmDIALOG_FILE_SELECTION +G + + +XmNhelpLabelString +XmCHelpLabelString +XmString +dynamic +CSG + + +XmNlistItemCount +XmCItemCount +int +dynamic +CSG + + +XmNlistItems +XmCItems +XmStringTable +dynamic +CSG + + +XmNlistLabelString +XmCListLabelString +XmString +dynamic +CSG + + +XmNlistVisibleItemCount +XmCVisibleItemCount +int +dynamic +CSG + + +XmNminimizeButtons +XmCMinimizeButtons +Boolean +False +CSG + + +XmNmustMatch +XmCMustMatch +Boolean +False +CSG + + +XmNnoMatchCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNokCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNokLabelString +XmCOkLabelString +XmString +dynamic +CSG + + +XmNselectionLabelString +XmCSelectionLabelString +XmString +dynamic +CSG + + +XmNtextAccelerators +XmCTextAccelerators +XtAccelerators +default +C + + +XmNtextColumns +XmCColumns +short +dynamic +CSG + + +XmNtextString +XmCTextString +XmString +dynamic +CSG + + + + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +False +CG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +Cancel button +SG + + +XmNdefaultButton +XmCWidget +Widget +OK button +SG + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +True +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + XmString value; + int length; + XmString mask; + int mask_length; + XmString dir; + int dir_length; + XmString pattern; + int pattern_length; +} XmFileSelectionBoxCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +value + +Specifies the current value of XmNdirSpec + + + + +length + +Specifies the number of bytes in value +This member is obsolete and exists for compatibility with +earlier releases. + + + + +mask + +Specifies the current value of XmNdirMask + + + + +mask_length + +Specifies the number of bytes in mask +This member is obsolete and exists for compatibility with +earlier releases. + + + + +dir + +Specifies the current base directory + + + + +dir_length + +Specifies the number of bytes in dir +This member is obsolete and exists for compatibility with +earlier releases. + + + + +pattern + +Specifies the current search pattern + + + + +pattern_length + +Specifies the number of bytes in pattern +This member is obsolete and exists for compatibility with +earlier releases. + + + + + + + + + + + + + + + + +Translations +XmFileSelectionBox inherits translations from XmSelectionBox. + + + +Accelerators +The XmNtextAccelerators from XmSelectionBox are added to the +selection and directory mask (filter) Text descendants of +XmFileSelectionBox. + + + +Action Routines +The XmFileSelectionBox action routines are + + + +SelectionBoxUpOrDown(Previous|Next|First|Last): + +If neither the selection text nor the directory mask (filter) text has +the focus, this action does nothing. + +If the selection text has the focus, the term list in the +following description refers to the file list, and the term text +refers to the selection text. +If the directory mask text has the focus, list refers to the +directory list, and text refers to the directory mask text. + +When called with an argument of Previous, or 0 (zero) for +compatibility, this action +selects the previous item in the +list and replaces the text with that item. + +When called with an argument of Next, or 1 for +compatibility, this action +selects the next item in the +list and replaces the text with that item. + +When called with an argument of First, or 2 for +compatibility, this action +selects the first item in the +list and replaces the text with that item. + +When called with an argument of Last, or 3 for +compatibility, this action +selects the last item in the +list and replaces the text with that item. + + + + +SelectionBoxRestore(): + +If neither the selection text nor the directory mask (filter) text has +the focus, this action does nothing. + +If the selection text has the focus, this action +replaces the selection text with +the selected item in the file list. +If no item in the file list is selected, it clears the selection text. + +If the directory mask text has the focus, this action +replaces the directory mask +text with a new directory mask constructed from the XmNdirectory +and XmNpattern resources. + + + + + + +Additional Behavior +The FileSelectionBox widget has the following additional behavior: + + + +KeyosfCancel: + +Calls the activate callbacks for the cancel button if it is sensitive. +If no cancel button exists and the parent of the FileSelectionBox is a manager, +it passes the event to the parent. + + + + +KeyosfActivate in Selection Text: + +Calls the selection text widget's XmNactivateCallback callbacks. +If XmNmustMatch is True and the selection text does not match an +item in the file list, it calls the XmNnoMatchCallback +callbacks with +reason XmCR_NO_MATCH. +Otherwise, it calls the XmNokCallback callbacks with reason +XmCR_OK. + + + + +KeyosfActivate in Directory Mask Text: + +Calls the directory mask text widget's XmNactivateCallback +callbacks, +initiates a directory and file search, and +calls the XmNapplyCallback callbacks with reason XmCR_APPLY. + + + + +Btn1Down(2+) or KeyosfActivate in Directory List: + +Calls the directory list widget's XmNdefaultActionCallback +callbacks, +initiates a directory and file search, +and calls the XmNapplyCallback callbacks with reason XmCR_APPLY. + + + + +Btn1Down(2+) or KeyosfActivate in File List: + +Calls the file list widget's XmNdefaultActionCallback +callbacks and +calls the XmNokCallback callbacks with reason XmCR_OK. + + + + +KeyosfSelect in Directory List: + +Generates a new directory mask, using the selected list item as the +directory and the pattern extracted from the current directory mask text +as the search pattern. +If the search pattern is empty, it uses a pattern that matches all files in +the directory. +Replaces the directory mask text with the new directory mask. + + + + +KeyosfSelect in File List: + +Replaces the selection text with the selected list item. + + + + +Btn2Down in File List: + +Drags the content of one or more selected list items using the drag +and drop facility. If <Btn2Down is pressed on an unselected item, +drags only that item, excluding any other selected items. + +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures of the file +list, possibly multiple times, for the _MOTIF_DROP selection. + + + + +Btn2Down in Directory List: + +Drags the content of one or more selected list items using the drag +and drop facility. If <Btn2Down is pressed on an unselected item, +it drags only that item, excluding any other selected items. + +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures of the +directory list, possibly multiple times, for the _MOTIF_DROP +selection. + + + + +Apply Button Activated: + +Initiates a directory and file search. +Calls the XmNapplyCallback callbacks with reason XmCR_APPLY. + + + + +OK Button Activated: + +If XmNmustMatch is True and the selection text does not match an +item in the file list, calls the XmNnoMatchCallback callbacks with +reason XmCR_NO_MATCH. +Otherwise, calls the XmNokCallback callbacks with reason +XmCR_OK. + + + + +Cancel Button Activated: + +Calls the XmNcancelCallback callbacks with reason +XmCR_CANCEL. + + + + +Help Button Activated: + +Calls the XmNhelpCallback callbacks with reason XmCR_HELP. + + + + +KeyosfActivate: + +If no button, list widget, or text widget has the keyboard focus, +if XmNmustMatch is True and the selection text does not match an +item in the file list, it calls the XmNnoMatchCallback callbacks with +reason XmCR_NO_MATCH. +Otherwise, it calls the XmNokCallback callbacks with reason +XmCR_OK. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmBulletinBoard;, +&cdeman.XmCreateFileSelectionBox;, +&cdeman.XmCreateFileSelectionDialog;, +&cdeman.XmFileSelectionBoxGetChild;, +&cdeman.XmFileSelectionDoSearch;, +&cdeman.XmManager;, and +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelB.sgm new file mode 100644 index 00000000..6a56f593 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelB.sgm @@ -0,0 +1,163 @@ + + + + + + + + + + + +XmFileSelectionBoxGetChild +library call + + +XmFileSelectionBoxGetChild +A FileSelectionBox function used to access a component + +XmFileSelectionBoxGetChild + +FileSelectionBox functions +XmFileSelectionBoxGetChild + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/FileSB.h> + +Widget XmFileSelectionBoxGetChild + +Widget widget +unsigned char child + + + +DESCRIPTION +XmFileSelectionBoxGetChild is used to access a component within a +FileSelectionBox. The parameters given to the function are the +FileSelectionBox widget and a value indicating which component to access. + +NOTE: This routine is obsolete and exists for compatibility with previous +releases. Instead of calling XmFileSelectionBoxGetChild, you should +call XtNameToWidget as described in the &cdeman.XmFileSelectionBox; +reference page. + + + +widget + +Specifies the FileSelectionBox widget ID. + + + + +child + +Specifies a component within the FileSelectionBox. The following are legal +values for this parameter: + + + +XmDIALOG_APPLY_BUTTON + + + +XmDIALOG_CANCEL_BUTTON + + + +XmDIALOG_DEFAULT_BUTTON + + + +XmDIALOG_DIR_LIST + + + +XmDIALOG_DIR_LIST_LABEL + + + +XmDIALOG_FILTER_LABEL + + + +XmDIALOG_FILTER_TEXT + + + +XmDIALOG_HELP_BUTTON + + + +XmDIALOG_LIST + + + +XmDIALOG_LIST_LABEL + + + +XmDIALOG_OK_BUTTON + + + +XmDIALOG_SELECTION_LABEL + + + +XmDIALOG_SEPARATOR + + + +XmDIALOG_TEXT + + + +XmDIALOG_WORK_AREA + + + + + + + +For a complete definition of FileSelectionBox and its associated resources, see +&cdeman.XmFileSelectionBox;. + + + +RETURN +Returns the widget ID of the specified FileSelectionBox component. +An application should not assume that the returned widget will be of any +particular class. + + + +RELATED +&cdeman.XmFileSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelC.sgm new file mode 100644 index 00000000..3e045a23 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FileSelC.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmFileSelectionDoSearch +library call + + +XmFileSelectionDoSearch +A FileSelectionBox function that initiates a directory search + +XmFileSelectionDoSearch + +FileSelectionBox functions +XmFileSelectionDoSearch + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/FileSB.h> + +void XmFileSelectionDoSearch + +Widget widget +XmString dirmask + + + +DESCRIPTION +XmFileSelectionDoSearch initiates a directory and file search in a +FileSelectionBox widget. +For a description of the actions that the FileSelectionBox takes when +doing a search, see &cdeman.XmFileSelectionBox;. + + + +widget + +Specifies the FileSelectionBox widget ID. + + + + +dirmask + +Specifies the directory mask used in determining the directories and +files displayed in the FileSelectionBox lists. +This value is used as the mask member of the input data +XmFileSelectionBoxCallbackStruct structure passed to the +FileSelectionBox's XmNqualifySearchDataProc. +The dir and pattern members of that structure are NULL. + + + + +For a complete definition of FileSelectionBox and its associated resources, see +&cdeman.XmFileSelectionBox;. + + + +RELATED +&cdeman.XmFileSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontList.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontList.sgm new file mode 100644 index 00000000..2ea793b5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontList.sgm @@ -0,0 +1,166 @@ + + + + + + + + + + + +XmFontList +library call + + +XmFontList +Data type for a font list + +XmFontList + +data types +XmFontList + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmFontList is the data type for a font list. A font list +consists of font list entries. Each entry contains a font or a +font set (a group of fonts) and is identified with a tag, +which is optional. If this tag is +NULL, the tag +is set to XmFONTLIST_DEFAULT_TAG. + +The value of +XmFONTLIST_DEFAULT_TAG is XmFONTLIST_DEFAULT_TAG_STRING. + +When a compound string is displayed, the font list element tag of the +compound string segment is matched with a font list entry tag in +the font list and the matching font list entry is used to display +the compound string. A font list entry is chosen as follows: + + + +The first font list entry whose tag matches the tag of the compound +string segment is used. + + + +If no match has been found and if the tag of the compound string +segment is XmFONTLIST_DEFAULT_TAG, the first font list +entry whose tag matches the tag that would result from creating +an entry with XmSTRING_DEFAULT_CHARSET is used. +For example, if creating an entry with XmSTRING_DEFAULT_CHARSET +would result in the tag ISO8859-1, the compound string segment +tag XmFONTLIST_DEFAULT_TAG matches the font list entry tag +ISO8859-1. + + + +If no match has been found and if the tag of the compound string +segment matches the tag that would result from creating a segment +with XmSTRING_DEFAULT_CHARSET, the first font list entry +whose tag is XmFONTLIST_DEFAULT_TAG is used. + + + +If no match has been found, the first entry in the font list is +used. + + + +The font list interface consists of the routines listed +in Related Information. + +Font lists are specified in resource files with the following syntax: + +resource_spec: font_entry [, font_entry ]+ + +The resource value string consists of one or more font list entries +separated by commas. Each font_entry identifies a font or +font set and an optional font list entry tag. A tag specified for a +single font follows the font name and is separated +by = (equals sign); otherwise, +in a font set the tag is separated by a colon. The colon is required +whether a tag is specified or not. A font entry uses the following +syntax to specify a single font: + +font_name [ '=' tag ] + +For example, the following entry specifies a 10 point Times Italic font +without a font list entry tag; + + +*fontList: -Adobe-Times-Medium-I-Normal--10* + + +A font entry containing a font set is similar, except a semicolon +separates multiple font names and the specification ends with +a colon followed by an optional tag: + +font_name [ ';' font_name ]+ ':' [ tag ] + +A font_name is an X Logical Font Description (XLFD) string +and tag is any set of characters from ISO646IRV except +space, comma, colon, equal sign and semicolon. Following is an example of a font +set entry. It consists of three fonts (except for charsets), +and an explicit font list entry tag. + + +*fontList: -Adobe-Courier-Bold-R-Normal--25-180-100-100-M-150;\ +-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240;\ +-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120:MY_TAG + + +Note that the XmRenderTable is another data type that can be +used for font lists. Refer to the &cdeman.XmRenderTable; for details. + + + +RELATED +&cdeman.XmFontListAdd;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListCopy;, +&cdeman.XmFontListCreate;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryGetTag;, +&cdeman.XmFontListEntryLoad;, +&cdeman.XmFontListFree;, +&cdeman.XmFontListFreeFontContext;, +&cdeman.XmFontListGetNextFont;, +&cdeman.XmFontListInitFontContext;, +&cdeman.XmFontListNextEntry;, +&cdeman.XmFontListRemoveEntry;, +&cdeman.XmRenderTable;, +and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstB.sgm new file mode 100644 index 00000000..577282af --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstB.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmFontListAdd +library call + + +XmFontListAdd +A font list function that creates a new font list + +XmFontListAdd + +font list functions +XmFontListAdd + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontList XmFontListAdd + +XmFontList oldlist +XFontStruct *font +XmStringCharSet charset + + + +DESCRIPTION +XmFontListAdd creates a new font list consisting of the contents of +oldlist and the new font list element being added. This +function deallocates oldlist after extracting the required +information; therefore, do not reference oldlist thereafter. + +NOTE: This function is obsolete and exists for compatibility +with previous releases. It has been replaced by XmFontListAppendEntry. + + + +oldlist + +Specifies a pointer to the font list to which an entry will be added. + + + + +font + +Specifies a pointer to a font structure for which the new font list is +generated. This is the structure returned by the XLib XLoadQueryFont +function. + + + + +charset + +Specifies the character set identifier for the font. +This can be XmSTRING_DEFAULT_CHARSET, but this value does not +comply with the AES, and it may be removed in future versions of Motif. +If the value is XmSTRING_DEFAULT_CHARSET, the routine derives the +character set from the current language environment. + + + + + + +RETURN +Returns NULL if oldlist is NULL; returns oldlist if +font or charset is NULL; otherwise, returns a new font list. + + + +RELATED +&cdeman.XmFontList; and +&cdeman.XmFontListAppendEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstD.sgm new file mode 100644 index 00000000..f1dd74a1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstD.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmFontListAppendEntry +library call + + +XmFontListAppendEntry +A font list function that appends an entry to a font list + +XmFontListAppendEntry + +font list functions +XmFontListAppendEntry + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontList XmFontListAppendEntry + +XmFontList oldlist +XmFontListEntry entry + + + +DESCRIPTION +XmFontListAppendEntry creates a new font list that +contains the contents of oldlist. This function +copies the contents of the font list entry being added +into this new font list. If oldlist is NULL, +XmFontListAppendEntry creates a new font list containing +only the single entry specified. + +This function deallocates the original font list after +extracting the required information. The caller must +free the font list entry by using XmFontListEntryFree. + + + +oldlist + +Specifies the font list to be added to + + + + +entry + +Specifies the font list entry to be added + + + + + + +RETURN +If entry is NULL, returns oldlist; otherwise, returns +a new font list. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryLoad;, +&cdeman.XmFontListFree;, and +&cdeman.XmFontListRemoveEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstH.sgm new file mode 100644 index 00000000..ab27317a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstH.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmFontListCopy +library call + + +XmFontListCopy +A font list function that copies a font list + +XmFontListCopy + +font list functions +XmFontListCopy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontList XmFontListCopy + +XmFontList fontlist + + + +DESCRIPTION +XmFontListCopy creates a new font list consisting of the contents +of the fontlist argument. + + + +fontlist + +Specifies a font list to be copied + + + + + + +RETURN +Returns NULL if +fontlist is NULL; +otherwise, returns a new font list +and allocates space to hold the font list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmFontListFree. + + + +RELATED +&cdeman.XmFontList; and +&cdeman.XmFontListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstJ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstJ.sgm new file mode 100644 index 00000000..38f298d7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstJ.sgm @@ -0,0 +1,104 @@ + + + + + + + + + + + +XmFontListCreate +library call + + +XmFontListCreate +A font list function that creates a font list + +XmFontListCreate + +font list functions +XmFontListCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontList XmFontListCreate + +XFontStruct * font +XmStringCharSet charset + + + +DESCRIPTION +XmFontListCreate creates a new font list with a single element specified +by the provided font and character set. It also allocates the space for +the font list. + +NOTE: This function is obsolete and exists for compatibility +with previous releases. It is replaced by XmFontListAppendEntry. + + + +font + +Specifies a pointer to a font structure for which the new font list is +generated. This is the structure returned by the XLib XLoadQueryFont +function. + + + + +charset + +Specifies the character set identifier for the font. +This can be XmSTRING_DEFAULT_CHARSET, but this value does not +comply with the AES, and it may be removed in future versions of Motif. +If the value +is XmSTRING_DEFAULT_CHARSET, the routine derives the +character set from the current language environment. + + + + + + +RETURN +Returns NULL if +font +or +charset +is NULL; otherwise, returns a new font list. + + + +RELATED +&cdeman.XmFontList; and +&cdeman.XmFontListAppendEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstK.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstK.sgm new file mode 100644 index 00000000..c562b550 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstK.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmFontListEntryCreate +library call + + +XmFontListEntryCreate +A font list function that creates a font list entry + +XmFontListEntryCreate + +font list functions +XmFontListEntryCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontListEntry XmFontListEntryCreate + +char *tag +XmFontType type +XtPointer font + + + +DESCRIPTION +XmFontListEntryCreate creates a font list entry that +contains either a font or font set and is identified by a tag. + + + +tag + +Specifies a NULL terminated string for the tag of the font +list entry. The tag may be specified as XmFONTLIST_DEFAULT_TAG, +which is used to identify the default font list element in a +font list. + + + + +type + +Specifies whether the font argument is a font structure or +a font set. Valid values are XmFONT_IS_FONT and +XmFONT_IS_FONTSET. + + + + +font + +Specifies either an XFontSet returned by XCreateFontSet or +a pointer to an XFontStruct returned by XLoadQueryFont. + + + + +The toolkit does not copy the X Font structure specified by the +font argument. Therefore, an application programmer must not +free XFontStruct or XFontSet until all font lists and/or font +entries that reference it have been freed. + + + +RETURN +Returns a font list entry. +The function allocates space to hold the +returned font list entry. The application is responsible for managing the +allocated space. The application can recover the allocated space by calling +XmFontListEntryFree. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryGetTag;, +&cdeman.XmFontListEntryLoad;, and +&cdeman.XmFontListRemoveEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstL.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstL.sgm new file mode 100644 index 00000000..1cc57e8f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstL.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmFontListEntryFree +library call + + +XmFontListEntryFree +A font list function that recovers +memory used by a font list entry + +XmFontListEntryFree + +font list functions +XmFontListEntryFree + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmFontListEntryFree + +XmFontListEntry *entry + + + +DESCRIPTION +XmFontListEntryFree recovers memory used by a font list entry. +This routine does not free the XFontSet or XFontStruct associated +with the font list entry. + + + +entry + +Specifies a pointer to the font list entry to be freed. +In addition, it may be necessary to take the address of the font list +entry (via the & operator) before passing it to this function. + + + + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryLoad;, +&cdeman.XmFontListNextEntry;, and +&cdeman.XmFontListRemoveEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstM.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstM.sgm new file mode 100644 index 00000000..101b67b8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstM.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmFontListEntryGetFont +library call + + +XmFontListEntryGetFont +A font list function +that retrieves font information from a font list entry + +XmFontListEntryGetFont + +font list functions +XmFontListEntryGetFont + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XtPointer XmFontListEntryGetFont + +XmFontListEntry entry +XmFontType *type_return + + + +DESCRIPTION +XmFontListEntryGetFont retrieves font information for a +specified font list entry. If the font list entry contains +a font, type_return returns XmFONT_IS_FONT and the +function returns a pointer to an XFontStruct. If the font list +entry contains a font set, type_return returns +XmFONT_IS_FONTSET and the function returns the XFontSet. + + + +entry + +Specifies the font list entry. + + + + +type_return + +Specifies a pointer to the type of the font element for the current +entry. Valid values are XmFONT_IS_FONT and +XmFONT_IS_FONTSET. + + + + +The returned XFontSet or XFontStruct is not a copy of the +toolkit data and must not be freed. + + + +RETURN +Returns an XFontSet or a pointer to an XFontStruct structure. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryGetTag; +&cdeman.XmFontListEntryLoad;, and +&cdeman.XmFontListNextEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstO.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstO.sgm new file mode 100644 index 00000000..d0a9f3fc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstO.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmFontListEntryGetTag +library call + + +XmFontListEntryGetTag +A font list function that +retrieves the tag of a font list entry + +XmFontListEntryGetTag + +font list functions +XmFontListEntryGetTag + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +char* XmFontListEntryGetTag + +XmFontListEntry entry + + + +DESCRIPTION +XmFontListEntryGetTag retrieves a copy of the tag of the specified +font list entry. This routine allocates memory for the tag string that +must be freed by the application. + + + +entry + +Specifies the font list entry + + + + + + +RETURN +Returns the tag for the font list entry. +The function allocates space to hold the returned tag. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XtFree. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryLoad;, and +&cdeman.XmFontListNextEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstP.sgm new file mode 100644 index 00000000..ab027932 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstP.sgm @@ -0,0 +1,143 @@ + + + + + + + + + + + +XmFontListEntryLoad +library call + + +XmFontListEntryLoad +A font list function that loads +a font or creates a font set and creates an accompanying font list entry + +XmFontListEntryLoad + +font list functions +XmFontListEntryLoad + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontListEntry XmFontListEntryLoad + +Display *display +char *font_name +XmFontType type +char *tag + + + +DESCRIPTION +XmFontListEntryLoad loads a font or creates a font set +based on the value of the type argument. It creates and returns +a font list entry that contains the font or font set and the +specified tag. + +If the value of type is XmFONT_IS_FONT, the function uses +the XtCvtStringToFontStruct routine to convert the value of +font_name to a font struct. +If the value of type is XmFONT_IS_FONTSET, the function uses +the XtCvtStringToFontSet converter to create a font set in the +current locale. +XmFontListEntryLoad creates a font list entry that contains the +font or font set derived from the converter. +For more information about XtCvtStringToFontStruct and +XtCvtStringToFontSet, see X Toolkit Intrinsics—C Language +Interface. + + + + +display + +Specifies the display where the font list will be used. + + + + +font_name + +Specifies an X Logical Font Description (XLFD) string, +which is interpreted either as a font name or as a base font name +list. +A base font name list is a comma-separated and NULL-terminated string. + + + + +type + +Specifies whether the font_name argument refers to a font name or +to a base font name list. +Valid values are XmFONT_IS_FONT and XmFONT_IS_FONTSET. + + + + +tag + +Specifies the tag of the font list entry to be created. +The tag may be specified as XmFONTLIST_DEFAULT_TAG, +which is used to identify the default font list +element in a font list when specified as part of a resource. + + + + + + +RETURN +If the specified font is not found, or if the specified font +set cannot be created, then either an implementation-defined font will +be opened or a font set will be created, and a warning messge will be +generated. If no suitable font can be found or a font set cannot be created, +then another message will be generated and the function will return +NULL; otherwise the function returns a font list entry. +If the function returns a font list entry, the function allocates space +to hold the font list entry. The application is responsible for managing +the allocated space. The application can recover the allocated space by +calling XmFontListEntryFree. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryGetTag;, and +&cdeman.XmFontListRemoveEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstQ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstQ.sgm new file mode 100644 index 00000000..bf082bc6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstQ.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmFontListFree +library call + + +XmFontListFree +A font list function that recovers memory used by a font list + +XmFontListFree + +font list functions +XmFontListFree + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmFontListFree + +XmFontList list + + + +DESCRIPTION +XmFontListFree recovers memory used by a font list. +This routine does not free the XFontSet or XFontStruct associated +with the specified font list. + + + +list + +Specifies the font list to be freed + + + + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListCopy;, and +&cdeman.XmFontListRemoveEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstS.sgm new file mode 100644 index 00000000..b434d8c7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstS.sgm @@ -0,0 +1,77 @@ + + + + + + + + + + + +XmFontListFreeFontContext +library call + + +XmFontListFreeFontContext +A font list function that instructs the toolkit that the font list context is no longer needed + +XmFontListFreeFontContext + +font list functions +XmFontListFreeFontContext + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmFontListFreeFontContext + +XmFontContext context + + + +DESCRIPTION +XmFontListFreeFontContext instructs the toolkit that the context +is no longer needed and will not be used without reinitialization. + + + +context + +Specifies the font list context structure that was allocated by the +XmFontListInitFontContext function + + + + + + +RELATED +&cdeman.XmFontListInitFontContext; and +&cdeman.XmFontListNextEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstT.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstT.sgm new file mode 100644 index 00000000..5aa8969d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstT.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmFontListGetNextFont +library call + + +XmFontListGetNextFont +A font list function that allows applications to access the fonts and character sets in a font list + +XmFontListGetNextFont + +font list functions +XmFontListGetNextFont + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmFontListGetNextFont + +XmFontContext context +XmStringCharSet *charset +XFontStruct **font + + + +DESCRIPTION +XmFontListGetNextFont accesses the character set and font for the +next entry of the font list. The application first uses the +XmFontListInitFontContext routine to create a font list context. +The application then calls XmFontListGetNextFont repeatedly with +the same context. Each succeeding call accesses the next element of +the font list. When finished, the application calls +XmFontListFreeFontContext to free the allocated font list context. + +This routine allocates memory for the character set string that must be +freed by the application. +The function allocates memory for charset. +The application is responsible for managing the allocated memory. +The application can recover the allocated memory by calling +XtFree. + +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmFontListNextEntry. +If XmFontListGetNextFont is passed a context that contains +a font set entry, it will return the first font of the +font set. The next call to the function will move to the next +entry in the font list. + + + +context + +Specifies the font list context + + + + +charset + +Specifies a pointer to a character set string; the routine returns the +character set for the current font list element + + + + +font + +Specifies a pointer to a pointer to a font structure; the routine +returns the font for the current font list element + + + + + + +RETURN +Returns True if the returned values are valid; otherwise, returns False. + + + +RELATED +&cdeman.XmFontList; and +&cdeman.XmFontListNextEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstU.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstU.sgm new file mode 100644 index 00000000..c187905d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstU.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmFontListInitFontContext +library call + + +XmFontListInitFontContext +A font list function that allows +applications to access the entries in a font list + +XmFontListInitFontContext + +font list functions +XmFontListInitFontContext + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmFontListInitFontContext + +XmFontContext *context +XmFontList fontlist + + + +DESCRIPTION +XmFontListInitFontContext +establishes a context to allow applications to access the contents +of a font list. This context is used when reading the font +list entry tag, font, or font set associated with each entry in +the font list. A Boolean status is returned to indicate whether +or not the font list is valid. + +If an application deallocates the font list passed to +XmFontListInitFontContext as the fontlist argument, the context +established by this function is rendered no longer valid. + + + +context + +Specifies a pointer to the allocated context + + + + +fontlist + +Specifies the font list + + + + + + +RETURN +Returns True if the context was allocated; otherwise, returns False. +If the function allocated a context, the application is responsible +for managing the allocated space. The application can recover the +allocated space by calling XmFontListFreeFontContext. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListFreeFontContext;, and +&cdeman.XmFontListNextEntry;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstV.sgm new file mode 100644 index 00000000..9a0e81e3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstV.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmFontListNextEntry +library call + + +XmFontListNextEntry +A font list function that returns +the next entry in a font list + +XmFontListNextEntry + +font list functions +XmFontListNextEntry + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontListEntry XmFontListNextEntry + +XmFontContext context + + + +DESCRIPTION +XmFontListNextEntry returns the next entry in the +font list. The application uses the XmFontListInitFontContext +routine to create a font list context. The first call to +XmFontListNextEntry sets the context to the first entry +in the font list. The application then calls XmFontListNextEntry +repeatedly with the same context. Each succeeding call accesses +the next entry of the font list. When finished, the application +calls XmFontListFreeFontContext to free the allocated font +list context. + + + +context + +Specifies the font list context + + + + + + +RETURN +Returns NULL if the context does not refer to a valid entry or if +it is at the end of the font list; otherwise, it returns a font list entry. +If the function does return a font list entry, the font list entry is not +a copy. Therefore, the application should not free the returned font list entry. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryGetTag;, +&cdeman.XmFontListFreeFontContext;, and +&cdeman.XmFontListInitFontContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstW.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstW.sgm new file mode 100644 index 00000000..c0b9b808 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/FontLstW.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmFontListRemoveEntry +library call + + +XmFontListRemoveEntry +A font list function that removes a font list entry from a font list + +XmFontListRemoveEntry + +font list functions +XmFontListRemoveEntry + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmFontList XmFontListRemoveEntry + +XmFontList oldlist +XmFontListEntry entry + + + +DESCRIPTION +XmFontListRemoveEntry creates a new font list +that contains the contents of oldlist +minus those entries specified in entry. +The routine removes any entries from oldlist +that match the components (tag, type font/font set) +of the specified entry. The function deallocates the +original font list after extracting the required +information. The caller uses XmFontListEntryFree +to recover memory allocated for the specified entry. This +routine does not free the XFontSet or XFontStruct associated +with the font list entry that is removed. + + + +oldlist + +Specifies the font list + + + + +entry + +Specifies the font list entry to be removed + + + + + + +RETURN +If oldlist is NULL, the function returns NULL. If +entry is NULL or no entries are removed, the function +returns oldlist. Otherwise, it returns a new font list. +If the function returns a new font list, the function allocates +space to hold the new font list. The application is responsible +for managing the allocated space. The application can recover the +allocated space by calling XmFontListFree. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryLoad;, and +&cdeman.XmFontListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Form.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Form.sgm new file mode 100644 index 00000000..15d973cd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Form.sgm @@ -0,0 +1,1588 @@ + + + + + + + + + + + +XmForm +library call + + +XmForm +The Form widget class + +XmForm + +widget class +Form + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Form.h> + + + +DESCRIPTION +Form is a container widget with no input semantics of its own. +Constraints are placed on children of the Form to define attachments +for each of the child's four sides. +These attachments can be to the Form, to another child widget or gadget, +to a relative position within the Form, or to the initial position of +the child. +The attachments determine the layout behavior of the Form when resizing +occurs. + +The default value for XmNinitialFocus is the value of +XmNdefaultButton. + +Following are some important considerations in using a Form: + + + +Every child must have an attachment on either the left or the right. +If initialization or XtSetValues leaves a widget without +such an attachment, the result depends upon the value of +XmNrubberPositioning. + +If XmNrubberPositioning is False, the child is given an +XmNleftAttachment of XmATTACH_FORM and an +XmNleftOffset equal to its current x value. + +If XmNrubberPositioning is True, the child is given an +XmNleftAttachment of XmATTACH_POSITION and an +XmNleftPosition proportional to the current x value divided +by the width of the Form. + +In either case, if the child has not been previously given an x +value, its x value is taken to be 0 (zero), which places the child at the +left side of the Form. + + + +If you want to create a child without any attachments, and then +later (for example, after creating and managing it, but before realizing it) +give it a right attachment through XtSetValues, you must set its +XmNleftAttachment to XmATTACH_NONE at the same time. + + + +The XmNresizable resource controls only whether a geometry request +by the child will be granted. +It has no effect on whether the child's size can be changed because of +changes in geometry of the Form or of other children. + + + +Every child has a preferred width, based on geometry requests it +makes (whether they are granted or not). + + + +If a child has attachments on both the left and the right sides, +its size is completely controlled by the Form. +It can be shrunk below its preferred width or enlarged above it, if +necessary, due to other constraints. +In addition, the child's geometry requests to change its own width may +be refused. + + + +If a child has attachments on only its left or right side, it will +always be at its preferred width (if resizable, otherwise at is current +width). +This may cause it to be clipped by the Form or by other children. + + + +If a child's left (or right) attachment is set to XmATTACH_SELF, its +corresponding left (or right) offset is forced to 0 (zero). +The attachment is then changed to XmATTACH_POSITION, with a +position that corresponds to the x value of the child's left (or +right) edge. +To fix the position of a side at a specific x value, use +XmATTACH_FORM or XmATTACH_OPPOSITE_FORM with the x +value as the left (or right) offset. + + + +Unmapping a child has no effect on the Form except that the child +is not mapped. + + + +Unmanaging a child unmaps it. +If no other child is attached to it, or if all children attached to it +and all children recursively attached to them are also all unmanaged, +all of those children are treated as if they did not exist in +determining the size of the Form. + + + +When using XtSetValues to change the XmNx resource of a +child, you must simultaneously set its left attachment to either +XmATTACH_SELF or XmATTACH_NONE. +Otherwise, the request is not granted. +If XmNresizable is False, the request is granted only if the +child's size can remain the same. + + + +A left (or right) attachment of XmATTACH_WIDGET, where +XmNleftWidget (or XmNrightWidget) is NULL, acts like an +attachment of XmATTACH_FORM. + + + +If an attachment is made to a widget that is not a child of the +Form, but an ancestor of the widget is a child of the Form, the +attachment is made to the ancestor. + + + +All these considerations are true of top and bottom attachments as well, +with top acting like left, bottom acting like right, y acting like +x, and height acting like width. + + +Classes +Form inherits behavior, resources, and traits from Core, +Composite, Constraint, +XmManager, and XmBulletinBoard. + +The class pointer is xmFormWidgetClass. + +The class name is XmForm. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in a .Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in a .Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate if the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmForm Resource Set + + +Name +Class +Type +Default +Access + + +XmNfractionBase +XmCMaxValue +int +100 +CSG + + +XmNhorizontalSpacing +XmCSpacing +Dimension +0 +CSG + + +XmNrubberPositioning +XmCRubberPositioning +Boolean +False +CSG + + +XmNverticalSpacing +XmCSpacing +Dimension +0 +CSG + + + + + + +XmNfractionBase + +Specifies the denominator used in calculating the relative position of +a child widget using XmATTACH_POSITION constraints. +The value must not be 0 (zero). + +If the value of a child's XmNleftAttachment (or +XmNrightAttachment) is XmATTACH_POSITION, the position of +the left (or right) side of the child is relative to the left +side of the Form and is a fraction of the width of the Form. +This fraction is the value of the child's XmNleftPosition (or +XmNrightPosition) resource divided by the value of the Form's +XmNfractionBase. + +If the value of a child's XmNtopAttachment (or +XmNbottomAttachment) is XmATTACH_POSITION, the position of +the top (or bottom) side of the child is relative to the top +side +of the Form and is a fraction of the height of the Form. +This fraction is the value of the child's XmNtopPosition (or +XmNbottomPosition) resource divided by the value of the Form's +XmNfractionBase. + + + + +XmNhorizontalSpacing + +Specifies the offset for right and left attachments. This resource is +only used if no offset resource is specified (when attaching to a +widget), or if no margin resource is specified (when attaching +to the Form). + + + + +XmNrubberPositioning + +Indicates the default near (left) and top attachments for a child of the +Form. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection.) + +The default left attachment is applied whenever initialization or +XtSetValues leaves the child without either a left or right +attachment. +The default top attachment is applied whenever initialization or +XtSetValues leaves the child without either a top or bottom +attachment. + +If this Boolean resource is set to False, XmNleftAttachment and +XmNtopAttachment default to XmATTACH_FORM, +XmNleftOffset defaults to the current x value of the left +side of the child, +and XmNtopOffset defaults to the current +y value of the child. +The effect is to position the child according to its absolute distance +from the left or top side of the Form. + +If this resource is set to True, XmNleftAttachment and +XmNtopAttachment default to XmATTACH_POSITION, +XmNleftPosition defaults to a value proportional to the current +x value of the left side of the child divided by the width of the +Form, and XmNtopPosition defaults to a value proportional to the +current y value of the child divided by the height of the Form. +The effect is to position the child relative to the left or top +side of the Form and in proportion to the width or height of the Form. + + + + +XmNverticalSpacing + +Specifies the offset for top and bottom attachments. This resource is +only used if no offset resource is specified (when attaching to a +widget), or if no margin resource is specified (when attaching +to the Form). + + + + + + + + + + + +XmForm Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomAttachment +XmCAttachment +unsigned char +XmATTACH_NONE +CSG + + +XmNbottomOffset +XmCOffset +int +0 +CSG + + +XmNbottomPosition +XmCPosition +int +0 +CSG + + +XmNbottomWidget +XmCWidget +Widget +NULL +CSG + + +XmNleftAttachment +XmCAttachment +unsigned char +XmATTACH_NONE +CSG + + +XmNleftOffset +XmCOffset +int +0 +CSG + + +XmNleftPosition +XmCPosition +int +0 +CSG + + +XmNleftWidget +XmCWidget +Widget +NULL +CSG + + +XmNresizable +XmCBoolean +Boolean +True +CSG + + +XmNrightAttachment +XmCAttachment +unsigned char +XmATTACH_NONE +CSG + + +XmNrightOffset +XmCOffset +int +0 +CSG + + +XmNrightPosition +XmCPosition +int +0 +CSG + + +XmNrightWidget +XmCWidget +Widget +NULL +CSG + + +XmNtopAttachment +XmCAttachment +unsigned char +XmATTACH_NONE +CSG + + +XmNtopOffset +XmCOffset +int +0 +CSG + + +XmNtopPosition +XmCPosition +int +0 +CSG + + +XmNtopWidget +XmCWidget +Widget +NULL +CSG + + + + + + + +XmNbottomAttachment + +Specifies attachment of the bottom side of the child. It can have the +following values: + + + +XmATTACH_NONE + +Do not attach the bottom side of the child. + + + + +XmATTACH_FORM + +Attach the bottom side of the child to the bottom +side of the Form. + + + + +XmATTACH_OPPOSITE_FORM + +Attach the bottom side of the child to +the top side of the Form. +XmNbottomOffset can be used to determine the visibility of the +child. + + + + +XmATTACH_WIDGET + +Attach the bottom side of the child to the top +side of the widget or +gadget specified in the XmNbottomWidget resource. +If XmNbottomWidget is NULL, XmATTACH_WIDGET is replaced by +XmATTACH_FORM, and the child is attached to the bottom side of the +Form. + + + + +XmATTACH_OPPOSITE_WIDGET + +Attach the bottom side of the child to +the bottom side of the widget or +gadget specified in the XmNbottomWidget resource. + + + + +XmATTACH_POSITION + +Attach the bottom side of the child to a +position that is relative to +the top side of the Form and in proportion to the height of the Form. +This position is determined by the XmNbottomPosition and +XmNfractionBase resources. + + + + +XmATTACH_SELF + +Attach the bottom side of the child to a position +that is proportional +to the current y value of the bottom of the child divided by the +height of the Form. +This position is determined by the XmNbottomPosition and +XmNfractionBase resources. +XmNbottomPosition is set to a value proportional to the current +y value of the bottom of the child divided by the height of the +Form. + + + + + + + + +XmNbottomOffset + +Specifies the constant offset between the bottom side of the +child and the object to which it is +attached. +The relationship established remains, regardless of any resizing operations +that occur. +When this resource is explicitly set, the value of XmNverticalSpacing +is ignored. + + + + +XmNbottomPosition + +This resource is used to determine the position of the bottom side of +the child when the child's XmNbottomAttachment is set to +XmATTACH_POSITION. +In this case the position of the bottom side of the child is relative to +the top side of the Form and is a fraction of the height of the Form. +This fraction is the value of the child's XmNbottomPosition +resource divided by the value of the Form's XmNfractionBase. +For example, if the child's XmNbottomPosition is 50, the Form's +XmNfractionBase is 100, and the Form's height is 200, the position +of the bottom side of the child is 100. + + + + +XmNbottomWidget + +Specifies the widget or gadget to which +the bottom side of the child is attached. +This resource is used if the XmNbottomAttachment resource +is set to either XmATTACH_WIDGET +or XmATTACH_OPPOSITE_WIDGET. + +A string-to-widget resource converter is automatically installed for use +with this resource. +With this converter, the widget that is to be the value of the resource +must exist at the time the widget that has the resource is created. + + + + +XmNleftAttachment + +Specifies attachment of the near (left) side of the child. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +It can have the following values: + + + +XmATTACH_NONE + +Do not attach the left side of the child. +If XmNrightAttachment is also XmATTACH_NONE, this value is +ignored and the child is given a default left attachment. + + + + +XmATTACH_FORM + +Attach the left side of the child to the left +side of the Form. + + + + +XmATTACH_OPPOSITE_FORM + +Attach the left side of the child to the +right side of the Form. +XmNleftOffset can be used to determine the visibility of the +child. + + + + +XmATTACH_WIDGET + +Attach the left side of the child to the right +side of the widget or +gadget specified in the XmNleftWidget resource. +If XmNleftWidget is NULL, XmATTACH_WIDGET is replaced by +XmATTACH_FORM, and the child is attached to the left side of the +Form. + + + + +XmATTACH_OPPOSITE_WIDGET + +Attach the left side of the child to +the left side of the widget or +gadget specified in the XmNleftWidget resource. + + + + +XmATTACH_POSITION + +Attach the left side of the child to a +position that is relative to +the left side of the Form and in proportion to the width of the Form. +This position is determined by the XmNleftPosition and +XmNfractionBase resources. + + + + +XmATTACH_SELF + +Attach the left side of the child to a position +that is proportional to +the current x value of the left side of the child divided by the +width of the Form. +This position is determined by the XmNleftPosition and +XmNfractionBase resources. +XmNleftPosition is set to a value proportional to the current +x value of the left side of the child divided by the width of the +Form. + + + + + + + +XmNleftOffset + +Specifies the constant offset between the near (left) side of the +child and the object to which it is attached. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +The relationship established remains, regardless of any resizing operations +that occur. +When this resource is explicitly set, the value of XmNhorizontalSpacing +is ignored. + + + + +XmNleftPosition + +This resource is used to determine the position of the near (left) side +of the child when the child's XmNleftAttachment is set to +XmATTACH_POSITION. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) + +In this case, the position of the left side of the child is relative to +the left side of the Form and is a fraction of the width of the Form. +This fraction is the value of the child's XmNleftPosition resource +divided by the value of the Form's XmNfractionBase. +For example, if the child's XmNleftPosition is 50, the Form's +XmNfractionBase is 100, and the Form's width is 200, the position +of the left side of the child is 100. + + + + +XmNleftWidget + +Specifies the widget or gadget to which the near (left) side of the +child is attached. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +The XmNleftWidget resource is used if the XmNleftAttachment +resource is set to either XmATTACH_WIDGET +or XmATTACH_OPPOSITE_WIDGET. + +A string-to-widget resource converter is automatically installed for use +with this resource. +With this converter, the widget that is to be the value of the resource +must exist at the time the widget that has the resource is created. + + + + +XmNresizable + +This Boolean resource specifies whether or not a child's request for a +new size is (conditionally) granted by the Form. +If this resource is set to True the request is granted if possible. +If this resource is set to False the request is always refused. + +If a child has both left and right attachments, its width is completely +controlled by the Form, regardless of the value of the child's +XmNresizable resource. +If a child has a left or right attachment but not both, the child's +XmNwidth is used in setting its width if the value of the child's +XmNresizable resource is True. +These conditions are also true for top and bottom attachments, with +height acting like width. + + + + +XmNrightAttachment + +Specifies attachment of the far (right) side of the child. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +It can have the following values: + + + +XmATTACH_NONE + +Do not attach the right side of the child. + + + + +XmATTACH_FORM + +Attach the right side of the child to the right +side of the Form. + + + + +XmATTACH_OPPOSITE_FORM + +Attach the right side of the child to +the left side of the Form. +XmNrightOffset can be used to determine the visibility of the +child. + + + + +XmATTACH_WIDGET + +Attach the right side of the child to the left +side of the widget or +gadget specified in the XmNrightWidget resource. +If XmNrightWidget is NULL, XmATTACH_WIDGET is replaced by +XmATTACH_FORM, and the child is attached to the right side of the +Form. + + + + +XmATTACH_OPPOSITE_WIDGET + +Attach the right side of the child to +the right side of the widget or +gadget specified in the XmNrightWidget resource. + + + + +XmATTACH_POSITION + +Attach the right side of the child to a +position that is relative to +the left side of the Form and in proportion to the width of the Form. +This position is determined by the XmNrightPosition and +XmNfractionBase resources. + + + + +XmATTACH_SELF + +Attach the right side of the child to a position +that is proportional to +the current x value of the right side of the child divided by the +width of the Form. +This position is determined by the XmNrightPosition and +XmNfractionBase resources. +XmNrightPosition is set to a value proportional to the current +x value of the right side of the child divided by the width of the +Form. + + + + + + + +XmNrightOffset + +Specifies the constant offset between the far (right) side of the +child and the object to which it is attached. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +The relationship established remains, regardless of any resizing operations +that occur. +When this resource is explicitly set, the value of XmNhorizontalSpacing +is ignored. + + + + +XmNrightPosition + +This resource is used to determine the position of the far (right) side +of the child when the child's XmNrightAttachment is set to +XmATTACH_POSITION. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) + +In this case the position of the right side of the child is relative to +the left side of the Form and is a fraction of the width of the Form. +This fraction is the value of the child's XmNrightPosition resource +divided by +the value of the Form's XmNfractionBase. +For example, if the child's XmNrightPosition is 50, the Form's +XmNfractionBase is 100, and the Form's width is 200, the position +of the right side of the child is 100. + + + + +XmNrightWidget + +Specifies the widget or gadget +to which the far (right) side of the child is attached. +(Note that whether this resource actually applies to the left or +right side of the child and its attachment +depends on the value of +the XmNlayoutDirection resource.) +The XmNrightWidget resource is used if the +XmNrightAttachment resource +is set to either XmATTACH_WIDGET +or XmATTACH_OPPOSITE_WIDGET. + +A string-to-widget resource converter is automatically installed for use +with this resource. +With this converter, the widget that is to be the value of the resource +must exist at the time the widget that has the resource is created. + + + + +XmNtopAttachment + +Specifies attachment of the top side of the child. It can have +following values: + + + +XmATTACH_NONE + +Do not attach the top side of the child. +If the XmNbottomAttachment resource +is also XmATTACH_NONE, this value is +ignored and the child is given a default top attachment. + + + + +XmATTACH_FORM + +Attach the top side of the child to the top side +of the Form. + + + + +XmATTACH_OPPOSITE_FORM + +Attach the top side of the child to the +bottom side of the Form. +XmNtopOffset can be used to determine the visibility of the +child. + + + + +XmATTACH_WIDGET + +Attach the top side of the child to the bottom +side of the widget or +gadget specified in the XmNtopWidget resource. +If XmNtopWidget is NULL, XmATTACH_WIDGET is replaced by +XmATTACH_FORM and the child is attached to the top side of the +Form. + + + + +XmATTACH_OPPOSITE_WIDGET + +Attach the top side of the child to +the top side of the widget or +gadget specified in the XmNtopWidget resource. + + + + +XmATTACH_POSITION + +Attach the top side of the child to a +position that is relative to +the top side of the Form and in proportion to the height of the Form. +This position is determined by the XmNtopPosition and +XmNfractionBase resources. + + + + +XmATTACH_SELF + +Attach the top side of the child to a position +that is proportional to +the current y value of the child divided by the height of the +Form. +This position is determined by the XmNtopPosition and +XmNfractionBase resources. +XmNtopPosition is set to a value proportional to the current +y value of the child divided by the height of the Form. + + + + + + + +XmNtopOffset + +Specifies the constant offset between the top side of the +child and the object to which it is +attached. +The relationship established remains, regardless of any resizing operations +that occur. +When this resource is explicitly set, the value of XmNverticalSpacing +is ignored. + + + + +XmNtopPosition + +This resource is used to determine the position of the top side of +the child when the child's XmNtopAttachment is set to +XmATTACH_POSITION. +In this case, the position of the top side of the child is relative to +the top side of the Form and is a fraction of the height of the Form. +This fraction is the value of the child's XmNtopPosition +resource divided by the value of the Form's XmNfractionBase. +For example, if the child's XmNtopPosition is 50, the Form's +XmNfractionBase is 100, and the Form's height is 200, the position +of the top side of the child is 100. + + + + +XmNtopWidget + +Specifies the widget or gadget to which the top +side of the child is attached. +This resource is used if XmNtopAttachment is +set to a value of either XmATTACH_WIDGET +or XmATTACH_OPPOSITE_WIDGET. + +A string-to-widget resource converter is automatically installed for use +with this resource. +With this converter, the widget that is to be the value of the resource +must exist at the time the widget that has the resource is created. + + + + + + +Inherited Resources +Form inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +True +CG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +NULL +SG + + +XmNdefaultButton +XmCWidget +Widget +NULL +SG + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +True +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +0 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +0 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +XmForm inherits translations from XmBulletinBoard. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, +&cdeman.XmBulletinBoard;, +XmCreateForm, &cdeman.XmCreateFormDialog;, and +&cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Frame.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Frame.sgm new file mode 100644 index 00000000..bcca9971 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Frame.sgm @@ -0,0 +1,783 @@ + + + + + + + + + + + +XmFrame +library call + + +XmFrame +The Frame widget class + +XmFrame + +widget class +Frame + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Frame.h> + + + +DESCRIPTION +Frame is a very simple manager used to enclose a single work +area child in a border drawn by Frame. +It uses the Manager class resources for border drawing and performs +geometry management so that its size always matches its child's outer size +plus the Frame's margins and shadow thickness. + +Frame is most often used to enclose other managers when the +application developer wants the manager to have the same border +appearance as the primitive widgets. Frame can also be +used to enclose primitive widgets that do not support the same +type of border drawing. This gives visual consistency when +you develop applications using diverse widget sets. +Constraint resources are used to designate a child as the Frame title, +align its text, and control its vertical alignment in relation to +Frame's top shadow. The title appears only at the top of the Frame. + +If the Frame's parent is a Shell widget, +the XmNshadowType resource defaults to XmSHADOW_OUT, and +the Manager's XmNshadowThickness resource defaults to 1. + +If the Frame's parent is not a Shell widget, +the XmNshadowType resouce defaults to XmSHADOW_ETCHED_IN, and +the Manager's XmNshadowThickness resource defaults to 2. + + +Classes +Frame inherits behavior and +resources from the Core, Composite, +Constraint, and XmManager classes. + +The class pointer is xmFrameWidgetClass. + +The class name is XmFrame. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmFrame Resource Set + + +Name +Class +Type +Default +Access + + +XmNmarginWidth +XmCMarginWidth +Dimension +0 +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +0 +CSG + + +XmNshadowType +XmCShadowType +unsigned char +dynamic +CSG + + + + + + +XmNmarginWidth + +Specifies the padding space on the left and right +sides between Frame's child and Frame's shadow drawing. + + + + +XmNmarginHeight + +Specifies the padding space on the top and bottom +sides between Frame's child and Frame's shadow drawing. +When a title is present, the top margin equals the value +specified by this resource plus the distance (if any) that the +title extends below the top shadow. + + + + +XmNshadowType + +Describes the drawing style for Frame. This resource can have the +following values: + + + +XmSHADOW_IN + +Draws Frame so that it appears inset. +This means that the bottom shadow visuals and top shadow visuals +are reversed. + + + + +XmSHADOW_OUT + +Draws Frame so that it appears outset. +This is the default if Frame's parent is a Shell widget. + + + + +XmSHADOW_ETCHED_IN + +Draws Frame using a double line giving the +effect of a line etched into the window. The thickness of the double +line is equal to the value of XmNshadowThickness. +This is the default when Frame's parent is not a Shell widget. + + + + +XmSHADOW_ETCHED_OUT + +Draws Frame using a double line giving the +effect of a line coming out of the window. The thickness of the double +line is equal to the value of XmNshadowThickness. + + + + + + + + + + + + + + + + + +XmFrame Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildType +XmCChildType +unsigned char +XmFRAME_WORKAREA_CHILD +CSG + + +XmNchildHorizontalAlignment +XmCChildHorizontalAlignment +unsigned char +XmALIGNMENT_BEGINNING +CSG + + +XmNchildHorizontalSpacing +XmCChildHorizontalSpacing +Dimension +dynamic +CSG + + +XmNchildVerticalAlignment +XmCChildVerticalAlignment +unsigned char +XmALIGNMENT_CENTER +CSG + + +XmNframeChildType +XmCFrameChildType +unsigned char +XmFRAME_WORKAREA_CHILD +CSG + + + + + + + +XmNchildType + + +Refer to the XmNframeChildType resource description. The +XmNchildType resource is obsoleted by XmNframeChildType, +but is kept here for backward compatibility. + + + + +XmNchildHorizontalAlignment + +Specifies the alignment of the title. This resource has the +following values: + + + +XmALIGNMENT_BEGINNING + + + +XmALIGNMENT_CENTER + + + +XmALIGNMENT_END + + + +See the description of XmNalignment in the XmLabel +reference page for an explanation of these values. + + + + +XmNchildHorizontalSpacing + +Specifies the minimum distance between either edge of the title text +and the inner edge of the Frame shadow. Clipping of the title +text occurs in order to maintain this spacing. The default value +is the margin width of the Frame. + + + + +XmNchildVerticalAlignment + +Specifies the vertical alignment of the title text, or the title +area in relation to the top shadow of the Frame. + + + +XmALIGNMENT_BASELINE_BOTTOM + +Causes the baseline of the +title to align vertically with the +top shadow of the Frame. In the case of a multi-line title, +the baseline of the last line of text aligns vertically with +the top shadow of the Frame. + + + + +XmALIGNMENT_BASELINE_TOP + +Causes the baseline of the first +line of the title to align vertically with the top shadow +of the Frame. + + + + +XmALIGNMENT_CHILD_TOP + +Causes the top edge of the title +area to align vertically with the top shadow of the Frame. + + + + +XmALIGNMENT_CENTER + +Causes the center of the title +area to align vertically with the top shadow of the Frame. + + + + +XmALIGNMENT_CHILD_BOTTOM + +Causes the bottom edge of the title +area to align vertically with the top shadow of the Frame. + + + + + + + +XmNframeChildType + +Specifies whether a child is a title or work area. Frame supports +a single title and/or work area child. The possible +values are + + + +XmFRAME_TITLE_CHILD + + + +XmFRAME_WORKAREA_CHILD + + + +XmFRAME_GENERIC_CHILD + + + +The Frame geometry manager ignores any child of type +XmFRAME_GENERIC_CHILD. +This resource replaces +XmNchildType. + + + + + + +Inherited Resources +Frame inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +XmFrame inherits translations from XmManager. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmCreateFrame;, and +&cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Gadget.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Gadget.sgm new file mode 100644 index 00000000..3278de61 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Gadget.sgm @@ -0,0 +1,769 @@ + + + + + + + + + + + +XmGadget +library call + + +XmGadget +The Gadget widget class + +XmGadget + +widget class +Gadget + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +Gadget is a widget class used as +a supporting superclass for other +gadget classes. It handles shadow-border drawing and highlighting, traversal +activation and deactivation, and various callback lists needed by +gadgets. + +The color and pixmap resources defined by XmManager are directly used by +gadgets. If XtSetValues is used +to change one of the resources for a manager +widget, all of the gadget children within the manager also change. + + +Classes +Gadget inherits behavior and resources from Object and +RectObj. + +The class pointer is xmGadgetClass. + +The class name is XmGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + +XmNbackground + +Specifies the background color for the gadget. + + + + +XmNbackgroundPixmap + +Specifies a pixmap for tiling the background. The first tile is +placed at the upper left corner of the widget's window. + + + + +XmNbottomShadowColor + +Contains the color to use to draw the bottom and right sides of the +border shadow. + + + + +XmNbottomShadowPixmap + +Specifies the pixmap to use to draw the bottom and right sides of the +border shadow. + + + + +XmNforeground + +Specifies the foreground drawing color used by Primitive widgets. + + + + +XmNhelpCallback + +Specifies the list of callbacks that is called when the help key sequence +is pressed. The reason sent by the callback is XmCR_HELP. + + + + +XmNhighlightColor + +Contains the color of the highlighting rectangle. + + + + +XmNhighlightOnEnter + +Specifies if the highlighting rectangle is drawn when the cursor moves +into the widget. +If the shell's focus policy is XmEXPLICIT, this resource is +ignored, and the widget is highlighted when it has the focus. +If the shell's focus policy is XmPOINTER and if this resource is +True, the highlighting rectangle is drawn when the the cursor moves into +the widget. +If the shell's focus policy is XmPOINTER and if this resource is +False, the highlighting rectangle is not drawn when the the cursor moves +into the widget. +The default is False. + + + + +XmNhighlightPixmap + +Specifies the pixmap used to draw the highlighting rectangle. + + + + +XmNhighlightThickness + +Specifies the thickness of the highlighting rectangle. + + + + +XmNlayoutDirection + +Specifies the direction in which components of the manager (including +strings) are laid out. The values are of type XmDirection. If +the widget's parent is a manager or shell, the value is inherited from +the widget's parent. Otherwise, it is inherited from the closest +ancestor vendor or menu shell. + + + + +XmNnavigationType + +Determines whether the widget is a tab group. + + + +XmNONE + +Indicates that the widget is not a tab group. + + + + +XmTAB_GROUP + +Indicates that the widget is a tab group, unless +the XmNnavigationType of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmSTICKY_TAB_GROUP + +Indicates that the widget is a tab group, even if the XmNnavigationType +of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmEXCLUSIVE_TAB_GROUP + +Indicates that the widget is a tab group and +that widgets in the hierarchy whose XmNnavigationType is +XmTAB_GROUP are not tab groups. + +When a parent widget has an XmNnavigationType of +XmEXCLUSIVE_TAB_GROUP, traversal of non-tab-group widgets within +the group is based on the order of those widgets in their parent's +XmNchildren list. + +When the XmNnavigationType of any widget in a hierarchy is +XmEXCLUSIVE_TAB_GROUP, +traversal of tab groups in the hierarchy +proceeds to widgets in the order in which their XmNnavigationType +resources were specified as XmEXCLUSIVE_TAB_GROUP or +XmSTICKY_TAB_GROUP, whether by creating the widgets with that value, +by calling XtSetValues, or by calling XmAddTabGroup. + + + + + + + +XmNshadowThickness + +Specifies the size of the drawn border shadow. + + + + +XmNtopShadowColor + +Contains the color to use to draw the top and left sides of the border +shadow. + + + + +XmNtopShadowPixmap + +Specifies the pixmap to use to draw the top and left sides of the border +shadow. + + + + +XmNtraversalOn + +Specifies traversal activation for this gadget. + + + + +XmNunitType + +Provides the basic support for resolution independence. +It defines the type of units a widget uses with sizing and +positioning resources. +If the widget's parent is a subclass of XmManager and if the +XmNunitType resource is not explicitly set, it defaults to the +unit type of the parent widget. +If the widget's parent is not a subclass of XmManager, the +resource has a default unit type of XmPIXELS. + +The unit type can also be specified in resource files, with the +following format: + + +<floating value><unit> + + +where: + + + +unit + +is <" ", pixels, inches, centimeters, millimeters, points, font units> + + + + +pixels + +is <pix, pixel, pixels> + + + + +inches + +is <in, inch, inches> + + + + +centimeter + +is <cm, centimeter, centimeters> + + + + +millimeters + +is <mm, millimeter, millimeters> + + + + +points + +is <pt, point, points> + + + + +font units + +is <fu, font_unit, font_units> + + + + +float + +is {"+"|"-"}{{<"0"-"9">*}.}<"0"-"9">* + +Note that the type Dimension must always be positive. + + + + +For example, + + +xmfonts*XmMainWindow.height: 10.4cm +*PostIn.width: 3inches + + +XmNunitType can have the following values: + + + +XmPIXELS + +All values provided to the widget are treated as normal +pixel values. + + + + +XmMILLIMETERS + +All values provided to the widget are treated as normal millimeter +values. + + + + +Xm100TH_MILLIMETERS + +All values provided to the widget are treated +as 1/100 of a millimeter. + + + + +XmCENTIMETERS + +All values provided to the widget are treated as normal centimeter +values. + + + + +XmINCHES + +All values provided to the widget are treated as normal inch +values. + + + + +Xm1000TH_INCHES + +All values provided to the widget are treated as +1/1000 of an inch. + + + + +XmPOINTS + +All values provided to the widget are treated as normal point +values. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +All values provided to the widget are treated as +1/100 of a point. A point is a unit used in text processing +applications and is defined as 1/72 inch. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as normal font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are +treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + + + + +XmNuserData + +Allows the application to attach any necessary specific data to the gadget. +This is an internally unused resource. + + + + + + +Inherited Resources +Gadget inherits resources from the +superclass described in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + + +reason + +Indicates why the callback was invoked. +For this callback, reason is set to XmCR_HELP. + + + + +event + +Points to the XEvent that triggered the callback. + + + + + + + + + + + + + + + + +Behavior +Gadgets cannot have translations associated with them. +Because of this, a Gadget's behavior is determined by the Manager +widget into which the Gadget is placed. If focus is on a Gadget, +events are passed to the Gadget by its Manager. + + + + +RELATED +&cdeman.Object;, +&cdeman.RectObj;, +&cdeman.XmManager;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetAtomN.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetAtomN.sgm new file mode 100644 index 00000000..f44b3349 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetAtomN.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmGetAtomName +library call + + +XmGetAtomName +A function that returns the string representation for an atom + +XmGetAtomName + +atoms + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/AtomMgr.h> + +String XmGetAtomName + +Display * display +Atom atom + + + +DESCRIPTION +XmGetAtomName returns the string representation for an atom. +It mirrors the Xlib interfaces for atom management but provides +client-side caching. When and where caching is provided in Xlib, the +routines will become pseudonyms for the Xlib routines. + + + +display + +Specifies the connection to the X server + + + + +atom + +Specifies the atom for the property name you want returned + + + + + + +RETURN +Returns a string. +The function allocates space to hold the returned string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XFree. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetColC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetColC.sgm new file mode 100644 index 00000000..89a41c23 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetColC.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + + +XmGetColorCalculation +library call + + +XmGetColorCalculation +A function to get the procedure used for default color calculation + +XmGetColorCalculation + +Color functions +XmGetColorCalculation + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmColorProc XmGetColorCalculation + + + + +DESCRIPTION +XmGetColorCalculation returns the procedure being used to calculate +default colors. + +For a description of XmColorProc, see &cdeman.XmSetColorCalculation;. + + + +RETURN +Returns the procedure used for default color calculation. + + + +RELATED +&cdeman.XmChangeColor;, +&cdeman.XmGetColors;, and +&cdeman.XmSetColorCalculation;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetCols.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetCols.sgm new file mode 100644 index 00000000..d44065a2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetCols.sgm @@ -0,0 +1,130 @@ + + + + + + + + + + + +XmGetColors +library call + + +XmGetColors +A function that generates foreground, select, and shadow colors + +XmGetColors + +Color functions +XmGetColors + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmGetColors + +Screen * screen +Colormap colormap +Pixel background +Pixel * foreground +Pixel * top_shadow +Pixel * bottom_shadow +Pixel * select + + + +DESCRIPTION +XmGetColors takes a screen, a colormap, and a background pixel, +and returns pixel values for foreground, select, and shadow colors. + + + +screen + +Specifies the screen for which these colors should be allocated. + + + + +colormap + +Specifies the colormap from which these colors should be allocated. + + + + +background + +Specifies the background on which the colors should be based. + + + + +foreground + +Specifies a pointer to the returned foreground pixel value. +If this argument is NULL, no value is allocated or returned for this color. + + + + +top_shadow + +Specifies a pointer to the returned top shadow pixel value. +If this argument is NULL, no value is allocated or returned for this color. + + + + +bottom_shadow + +Specifies a pointer to the returned bottom shadow pixel value. +If this argument is NULL, no value is allocated or returned for this color. + + + + +select + +Specifies a pointer to the returned select pixel value. +If this argument is NULL, no value is allocated or returned for this color. + + + + + + +RELATED +&cdeman.XmChangeColor;, +&cdeman.XmGetColorCalculation;, and +&cdeman.XmSetColorCalculation;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDest.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDest.sgm new file mode 100644 index 00000000..d53bc5d3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDest.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmGetDestination +library call + + +XmGetDestination +A function that returns the widget ID of the widget to be used as the current destination for quick paste and certain clipboard operations + +XmGetDestination + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmGetDestination + +Display *display + + + +DESCRIPTION +XmGetDestination returns the widget that is the current destination +on the specified display. +The destination is generally the last editable widget on which a +select, edit, insert, or paste operation was performed and is the +destination for quick paste and certain clipboard functions. +The destination is NULL until a keyboard or mouse operation has been +done on an editable widget. Refer to the &MotifProgGd; for a description of +keyboard focus. + + + +display + +Specifies the display whose destination widget is to be queried + + + + + + +RETURN +Returns the widget ID for the current destination or NULL if there is +no current destination. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDragC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDragC.sgm new file mode 100644 index 00000000..3cf2d013 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetDragC.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmGetDragContext +library call + + +XmGetDragContext +A Drag and Drop function that retrieves the +DragContext widget ID associated with a timestamp + +XmGetDragContext + +Drag and Drop functions +XmGetDragContext + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragC.h> + +Widget XmGetDragContext + +Widget refwidget +Time timestamp + + + +DESCRIPTION +XmGetDragContext returns the widget ID of the active +DragContext associated with a given display and timestamp. A timestamp +uniquely identifies which DragContext is active when more than +one drag and drop transaction has been initiated on a display. If +the specified timestamp matches a timestamp processed between +the start and finish of a single drag and drop transaction, the +function returns the corresponding DragContext ID. + + + +refwidget + +Specifies the ID of the widget that the routine uses to identify +the intended display. The function returns the ID of the +DragContext associated with the display value passed by this widget. + + + + +timestamp + +Specifies a timestamp. + + + + +For a complete definition of DragContext and its associated resources, +see &cdeman.XmDragContext;. + + + +RETURN +Returns the ID of the DragContext widget that is active for the +specified timestamp. Otherwise, returns NULL if no active +DragContext is found. + + + +RELATED +&cdeman.XmDragContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetFocW.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetFocW.sgm new file mode 100644 index 00000000..cf513198 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetFocW.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + + +XmGetFocusWidget +library call + + +XmGetFocusWidget +Returns the ID of the widget that has +keyboard focus + +XmGetFocusWidget + +traversal functions +XmGetFocusWidget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmGetFocusWidget + +Widget widget + + + +DESCRIPTION +XmGetFocusWidget examines the hierarchy that contains +the specified widget and returns the ID of the widget that +has keyboard focus. The function extracts the widget ID +from the associated Shell widget; therefore, the specified +widget can be located anywhere in the hierarchy. + + + +widget + +Specifies a widget ID within a given hierarchy + + + + + + +RETURN +Returns the ID of the widget with keyboard focus. If no child +of the Shell has focus, the function returns NULL. + + + +RELATED +&cdeman.XmProcessTraversal;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetMenuC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetMenuC.sgm new file mode 100644 index 00000000..77c06514 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetMenuC.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmGetMenuCursor +library call + + +XmGetMenuCursor +A function that returns the cursor ID for the current menu cursor + +XmGetMenuCursor + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Cursor XmGetMenuCursor + +Display * display + + + +DESCRIPTION +XmGetMenuCursor queries the menu +cursor currently being used by this client on the specified display and returns +the cursor ID. +This function returns the menu cursor for the default screen of the +display. + +NOTE: XmGetMenuCursor is obsolete and exists for compatibility with +previous releases. +Instead of using this function, call XtGetValues for the XmScreen +resource XmNmenuCursor. + + + +display + +Specifies the display whose menu cursor is to be queried + + + + + + +RETURN +Returns the cursor ID for the current menu cursor or the value None if +a cursor is not yet defined. A cursor will not be defined +if the application makes this call before the client has created any menus +on the specified display. + + + +RELATED +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixA.sgm new file mode 100644 index 00000000..ccd7538d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixA.sgm @@ -0,0 +1,378 @@ + + + + + + + + + + + +XmGetPixmap +library call + + +XmGetPixmap +A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap + +XmGetPixmap + +pixmaps + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Pixmap XmGetPixmap + +Screen *screen +char *image_name +Pixel foreground +Pixel background + + + +DESCRIPTION +XmGetPixmap +uses the parameter data to perform a lookup in the +pixmap cache to see if a pixmap has already been generated that +matches the data. If one is found, a reference count is incremented +and the pixmap is returned. Applications should use XmDestroyPixmap +when the pixmap is no longer needed. + + + +screen + +Specifies the display screen on which the pixmap is to +be drawn. +The depth of the pixmap is the default depth for this screen. + + + + +image_name + +Specifies the name of the image to be used to +generate the pixmap + + + + +foreground + +Combines the image with the foreground color to create the pixmap +if the image referenced is a bit-per-pixel image + + + + +background + +Combines the image with the background color to create the pixmap +if the image referenced is a bit-per-pixel image + + + + +If a pixmap is not found, image_name is used to perform a lookup in +the image cache. If an image is found, it is used to generate the pixmap, +which is then cached and returned. + +If an image is not found, the +image_name is used as a filename, and a search is made for +an X10 or X11 bitmap file. If it is found, the file is +read, converted into an image, and cached in the image cache. The image +is then used to generate a pixmap, which is cached and returned. + +If image_name has a leading slash (/), it specifies a full +pathname, and XmGetPixmap opens the file as specified. +Otherwise, image_name specifies a filename. +In this case, XmGetPixmap looks for the file along a search path +specified by the XBMLANGPATH environment variable or by a default +search path, which varies depending on whether or not the +XAPPLRESDIR environment variable is set. +The default search path contains a lot of directories. +Therefore, XmGetPixmap will need a relatively +long time to search through all these directories for pixmaps +and bitmaps. Applications that use a lot of pixmaps and bitmaps +will probably run more quickly if +XBMLANGPATH is set to a short list of directories. +In addition to X bitmap files (XBM), Motif also supports XPM (X +Pixmap) file formats. The XBMLANGPATH specifies the path for +both XBM and XPM files. Refer to the XmGetPixmapByDepth reference +page for further details. + +The XBMLANGPATH environment variable specifies a search path +for X bitmap files. +It can contain the substitution field %B, where the image_name +argument to XmGetPixmap is substituted for %B. +It can also contain the substitution fields accepted by +XtResolvePathname. +The substitution field %T is always mapped to bitmaps, and %S is +always mapped to NULL. + +If XBMLANGPATH is not set but the environment variable +XAPPLRESDIR is set, the following pathnames are searched: + + + +%B + + + +$XAPPLRESDIR/%L/bitmaps/%N/%B + + + +$XAPPLRESDIR/%l_%t/bitmaps/%N/%B + + + +$XAPPLRESDIR/%l/bitmaps/%N/%B + + + +$XAPPLRESDIR/bitmaps/%N/%B + + + +$XAPPLRESDIR/%L/bitmaps/%B + + + +$XAPPLRESDIR/%l_%t/bitmaps/%B + + + +$XAPPLRESDIR/%l/bitmaps/%B + + + +$XAPPLRESDIR/bitmaps/%B + + + +$HOME/bitmaps/%B + + + +$HOME/%B + + + +/usr/lib/X11/%L/bitmaps/%N/%B + + + +/usr/lib/X11/%l_%t/bitmaps/%N/%B + + + + +/usr/lib/X11/%l/bitmaps/%N/%B + + + +/usr/lib/X11/bitmaps/%N/%B + + + +/usr/lib/X11/%L/bitmaps/%B + + + +/usr/lib/X11/%l_%t/bitmaps/%B + + + + +/usr/lib/X11/%l/bitmaps/%B + + + +/usr/lib/X11/bitmaps/%B + + + +/usr/include/X11/bitmaps/%B + + + +If neither XBMLANGPATH nor XAPPLRESDIR is set, the +following pathnames are searched: + + + +%B + + + +$HOME/%L/bitmaps/%N/%B + + + +$HOME/%l_%t/bitmaps/%N/%B + + + + +$HOME/%l/bitmaps/%N/%B + + + +$HOME/bitmaps/%N/%B + + + +$HOME/%L/bitmaps/%B + + + +$HOME/%l_%t/bitmaps/%B + + + + +$HOME/%l/bitmaps/%B + + + +$HOME/bitmaps/%B + + + +$HOME/%B + + + +/usr/lib/X11/%L/bitmaps/%N/%B + + + + +/usr/lib/X11/%l_%t/bitmaps/%N/%B + + + + +/usr/lib/X11/%l/bitmaps/%N/%B + + + +/usr/lib/X11/bitmaps/%N/%B + + + +/usr/lib/X11/%L/bitmaps/%B + + + +/usr/lib/X11/%l_%t/bitmaps/%B + + + + +/usr/lib/X11/%l/bitmaps/%B + + + +/usr/lib/X11/bitmaps/%B + + + +/usr/include/X11/bitmaps/%B + + + +These paths are defaults that vendors may change. +For example, a vendor may use different directories for +/usr/lib/X11 and /usr/include/X11. + +The following substitutions are used in these paths: + + + +%B + +The image name, from the image_name argument + + + + +%N + +The class name of the application + + + + +%L + +The display's language string. +This string is influenced by XtSetLanguageProc. +The default string is determined by +calling setlocale(LC_ALL, NULL). + + + + +%l_%t + +The language and territory component of the display's language string + + + + + + +%l + +The language component of the display's language string + + + + +The contents of the file must conform to the rules for +X11 bitmap files. In other words, Motif can read any X11 +conformant bitmap file. + + + +RETURN +Returns a pixmap when successful; returns XmUNSPECIFIED_PIXMAP +if the image corresponding to image_name cannot be found. + + + +RELATED +&cdeman.XmDestroyPixmap;, +&cdeman.XmGetPixmapByDepth;, +&cdeman.XmInstallImage;, and +&cdeman.XmUninstallImage;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixB.sgm new file mode 100644 index 00000000..2bac801f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPixB.sgm @@ -0,0 +1,446 @@ + + + + + + + + + + + +XmGetPixmapByDepth +library call + + +XmGetPixmapByDepth +A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap + +XmGetPixmapByDepth + +pixmaps + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Pixmap XmGetPixmapByDepth + +Screen *screen +char *image_name +Pixel foreground +Pixel background +int depth + + + +DESCRIPTION +XmGetPixmapByDepth uses the parameter data to perform a lookup in the +pixmap cache to see if a pixmap has already been generated that +matches the data. If one is found, a reference count is incremented +and the pixmap is returned. Applications should use XmDestroyPixmap +when the pixmap is no longer needed. + + + +screen + +Specifies the display screen on which the pixmap is to +be drawn + + + + +image_name + +Specifies the name of the image to be used to +generate the pixmap + + + + +foreground + +Combines the image with the foreground color to create the pixmap +if the image referenced is a bit-per-pixel image + + + + +background + +Combines the image with the background color to create the pixmap +if the image referenced is a bit-per-pixel image + + + + +depth + +Specifies the depth of the pixmap + + + + +If a matching pixmap is not found, +image_name is used to perform a lookup in +the image cache. If an image is found, it is used to generate the pixmap, +which is then cached and returned. + +If an image is not found, +image_name is used as a filename, and a search is made for +an X10 or X11 bitmap file. If it is found, the file is +read, converted into an image, and cached in the image cache. The image +is then used to generate a pixmap, which is cached and returned. + +If image_name has a leading / (slash), it specifies a full +pathname, and XmGetPixmapByDepth opens the file as specified. +Otherwise, image_name specifies a filename. +In this case, XmGetPixmapByDepth looks for the file along a search +path specified by the XBMLANGPATH environment variable or by a +default search path, which varies depending on whether or not the +XAPPLRESDIR environment variable is set. +The default search path contains a lot of directories. +Therefore, XmGetPixmapByDepth will need a relatively +long time to search through all these directories for pixmaps +and bitmaps. Applications that use a lot of pixmaps and bitmaps +will probably run more quickly if +XBMLANGPATH is set to a short list of directories. +In addition to X bitmap files (XBM), Motif also supports XPM (X +Pixmap) file formats. The XBMLANGPATH specifies the path for +both XBM and XPM files. XPM files are described in more detail later +in this reference page. + +The XBMLANGPATH environment variable specifies a search path +for X bitmap files. +It can contain the substitution field %B, where the image_name +argument to XmGetPixmapByDepth is substituted for %B. +It can also contain the substitution fields accepted by +XtResolvePathname. +The substitution field %T is always mapped to bitmaps, and %S is +always mapped to NULL. + +If XBMLANGPATH is not set, but the environment variable +XAPPLRESDIR is set, the following pathnames are searched: + + + +%B + + + +$XAPPLRESDIR/%L/bitmaps/%N/%B + + + +$XAPPLRESDIR/%l_%t/bitmaps/%N/%B + + + + +$XAPPLRESDIR/%l/bitmaps/%N/%B + + + +$XAPPLRESDIR/bitmaps/%N/%B + + + +$XAPPLRESDIR/%L/bitmaps/%B + + + +$XAPPLRESDIR/%l_%t/bitmaps/%B + + + + +$XAPPLRESDIR/%l/bitmaps/%B + + + +$XAPPLRESDIR/bitmaps/%B + + + +$HOME/bitmaps/%B + + + +$HOME/%B + + + +/usr/lib/X11/%L/bitmaps/%N/%B + + + + +/usr/lib/X11/%l_%t/bitmaps/%N/%B + + + + +/usr/lib/X11/%l/bitmaps/%N/%B + + + +/usr/lib/X11/bitmaps/%N/%B + + + +/usr/lib/X11/%L/bitmaps/%B + + + + +/usr/lib/X11/%l_%t/bitmaps/%B + + + + +/usr/lib/X11/%l/bitmaps/%B + + + +/usr/lib/X11/bitmaps/%B + + + +/usr/include/X11/bitmaps/%B + + + +If neither XBMLANGPATH nor XAPPLRESDIR is set, the +following pathnames are searched: + + + +%B + + + +$HOME/%L/bitmaps/%N/%B + + + + +$HOME/%l_%t/bitmaps/%N/%B + + + + +$HOME/%l/bitmaps/%N/%B + + + +$HOME/bitmaps/%N/%B + + + +$HOME/%L/bitmaps/%B + + + + +$HOME/%l_%t/bitmaps/%B + + + + +$HOME/%l/bitmaps/%B + + + +$HOME/bitmaps/%B + + + +$HOME/%B + + + +/usr/lib/X11/%L/bitmaps/%N/%B + + + + +/usr/lib/X11/%l_%t/bitmaps/%N/%B + + + + +/usr/lib/X11/%l/bitmaps/%N/%B + + + +/usr/lib/X11/bitmaps/%N/%B + + + +/usr/lib/X11/%L/bitmaps/%B + + + +/usr/lib/X11/%l_%t/bitmaps/%B + + + + +/usr/lib/X11/%l/bitmaps/%B + + + +/usr/lib/X11/bitmaps/%B + + + +/usr/include/X11/bitmaps/%B + + + +These paths are defaults that vendors may change. +For example, a vendor may use different directories for +/usr/lib/X11 and /usr/include/X11. + +The following substitutions are used in these paths: + + + +%B + +The image name, from the image_name argument + + + + +%N + +The class name of the application + + + + +%L + +The display's language string. +This string is influenced by XtSetLanguageProc. +The default string is determined by +calling setlocale(LC_ALL, NULL). + + + + +%l_%t + +The language and territory component of the display's language string + + + + + +%l + +The language component of the display's language string + + + + +The contents of the file must conform to the rules for +X11 bitmap files. In other words, Motif can read any X11 +conformant bitmap file. + +The XPM file format is used for +storing or getting back colored X pixmaps from files. The XPM library +is provided as unsupported with Motif. To build applications without +XPM, use the NO_XPM macro. +The following shows both XBM and XPM files, respectively, +for a plaid pattern. + + +/* XBM file */ +&npzwc;#define plaid_width 22 +&npzwc;#define plaid_height 22 +&npzwc;#define plaid_x_hot -1 +&npzwc;#define plaid_y_hot -1 +static char plaid_bits[] = { + 0x75, 0xfd, 0x3f, 0xaa, 0xfa, 0x3e, 0x75, 0xfd, 0x3f, 0xaa, 0xfa, 0x3e, + 0x75, 0xfd, 0x3f, 0xff, 0x57, 0x15, 0x75, 0xfd, 0x3f, 0xaa, 0xfa, 0x3e, + 0x75, 0xfd, 0x3f, 0xaa, 0xfa, 0x3e, 0x75, 0xfd, 0x3f, 0x20, 0xa8, 0x2b, + 0x20, 0x50, 0x15, 0x20, 0xa8, 0x2b, 0x20, 0x50, 0x15, 0x20, 0xa8, 0x2b, + 0xff, 0xff, 0x3f, 0x20, 0xa8, 0x2b, 0x20, 0x50, 0x15, 0x20, 0xa8, 0x2b, + 0x20, 0x50, 0x15, 0x20, 0xa8, 0x2b}; + + + +/* XPM file */ +static char * plaid[] = { +/* plaid pixmap + * width height ncolors chars_per_pixel */ +"22 22 4 2 ", +/* colors */ +" c red m white s light_color ", +"Y c green m black s lines_in_mix ", +"+ c yellow m white s lines_in_dark ", +"x m black s dark_color ", +/* pixels */ +"x x x x x x x x x x x x + x x x x x ", +" x x x x x x x x x x x x x x x x ", +"x x x x x x x x x x x x + x x x x x ", +" x x x x x x x x x x x x x x x x ", +"x x x x x x x x x x x x + x x x x x ", +"Y Y Y Y Y x Y Y Y Y Y + x + x + x + x + x + ", +"x x x x x x x x x x x x + x x x x x ", +" x x x x x x x x x x x x x x x x ", +"x x x x x x x x x x x x + x x x x x ", +" x x x x x x x x x x x x x x x x ", +"x x x x x x x x x x x x + x x x x x ", +" x x x x Y x x x ", +" x x x Y x x ", +" x x x x Y x x x ", +"x x x x x x x x x x x x x x x x x x x x x x ", +" x x x x Y x x x ", +" x x x Y x x ", +" x x x x Y x x x ", +" x x x Y x x ", +" x x x x Y x x x " +}; + + + + +RETURN +Returns a pixmap when successful; returns XmUNSPECIFIED_PIXMAP +if the image corresponding to image_name cannot be found. + + + +RELATED +&cdeman.XmDestroyPixmap;, +&cdeman.XmInstallImage;, and +&cdeman.XmUninstallImage;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPost.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPost.sgm new file mode 100644 index 00000000..f73aa321 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetPost.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmGetPostedFromWidget +library call + + +XmGetPostedFromWidget +A RowColumn function that returns the widget from which a menu was posted + +XmGetPostedFromWidget + +RowColumn functions +XmGetPostedFromWidget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmGetPostedFromWidget + +Widget menu + + + +DESCRIPTION +XmGetPostedFromWidget returns the widget from which a menu was +posted. +For torn-off menus, this function returns the widget +from which the menu was originally torn. +An application can use this routine during the activate callback to +determine the context in which the menu callback should be interpreted. + + + +menu + +Specifies the widget ID of the menu + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the widget ID of the widget from which the menu was posted. +If the menu is a Popup Menu, the returned widget is the widget from +which the menu was popped up. +If the menu is a Pulldown Menu, the returned widget is the MenuBar or +OptionMenu from which the widget was pulled down. + + + +RELATED +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetSec.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetSec.sgm new file mode 100644 index 00000000..49f3ec71 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetSec.sgm @@ -0,0 +1,132 @@ + + + + + + + + + + + +XmGetSecondaryResourceData +library call + + +XmGetSecondaryResourceData +A function that provides access to secondary widget resource data + +XmGetSecondaryResourceData + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Cardinal XmGetSecondaryResourceData + +WidgetClass widget_class +XmSecondaryResourceData **secondary_data_return + + + +DESCRIPTION +Some Motif widget classes (such as Gadget, Text, and VendorShell) have +resources that are not accessible through the functions +XtGetResourceList and XtGetConstraintResourceList. +In order to retrieve the descriptions of these resources, an application +must use XmGetSecondaryResourceData. + +When a widget class has such resources, this function provides +descriptions of the resources in one or more data structures. +XmGetSecondaryResourceData takes a widget class argument and +returns the number of these data structures associated with the widget +class. +If the return value is greater than 0 (zero), the function allocates and fills +an array of pointers to the corresponding data structures. +It returns this array at the address that is the value of the +secondary_data_return argument. + +The type XmSecondaryResourceData is a pointer to a structure with +two members that are useful to an application: resources, of type +XtResourceList, and num_resources, of type Cardinal. +The resources member is a list of the widget resources that are +not accessible using Xt functions. +The num_resources member is the length of the resources +list. + +If the return value is greater than 0 (zero), XmGetSecondaryResourceData +allocates memory that the application must free. +Use XtFree to free the resource list in each structure (the value +of the resources member), the structures themselves, and the array +of pointers to the structures (the array whose address is +secondary_data_return). + + + +widget_class + +Specifies the widget class for which secondary resource data is to be +retrieved. + + + + +secondary_data_return + +Specifies a pointer to an array of XmSecondaryResourceData +pointers to be returned by this function. +If the widget class has no secondary resource data, for example, if the value +returned by the function is 0 (zero), the function returns no meaningful value +for this argument. + + + + + + +RETURN +Returns the number of secondary resource data structures associated with +this widget class. + + + +EXAMPLE +The following example uses XmGetSecondaryResourceData to print the +names of the secondary resources of the Motif Text widget and then frees +the data allocated by the function: + + +XmSecondaryResourceData * block_array; +Cardinal num_blocks, i, j; +if (num_blocks = XmGetSecondaryResourceData (xmTextWidgetClass, + &block_array)) { + for (i = 0; i < num_blocks; i++) { + for (j = 0; j < block_array[i]->num_resources; j++) { + printf("%s\n", block_array[i]->resources[j].resource_name); + } + XtFree((char*)block_array[i]->resources); + XtFree((char*)block_array[i]); + } + XtFree((char*)block_array); +} + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTabGr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTabGr.sgm new file mode 100644 index 00000000..56500835 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTabGr.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + +XmGetTabGroup +library call + + +XmGetTabGroup +Returns the widget ID of a tab group + +XmGetTabGroup + +traversal functions +XmGetTabGroup + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmGetTabGroup + +Widget widget + + + +DESCRIPTION +XmGetTabGroup returns the widget ID of the tab group that +contains the specified widget. + + + +widget + +Specifies a widget ID within a tab group + + + + + + +RETURN +Returns the widget ID of a tab group or shell, determined as follows: + + + +If widget is a tab group or shell, returns widget + + + +If neither widget nor any ancestor up to the nearest shell is a tab +group, returns the nearest ancestor of widget that is a shell + + + +Otherwise, returns the nearest ancestor of widget that is a tab group + + + + + +RELATED +&cdeman.XmAddTabGroup;, +&cdeman.XmManager;, and +&cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTearO.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTearO.sgm new file mode 100644 index 00000000..de23a9ea --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetTearO.sgm @@ -0,0 +1,103 @@ + + + + + + + + + + + +XmGetTearOffControl +library call + + +XmGetTearOffControl +A RowColumn function that obtains the widget ID for the tear-off control in a menu + +XmGetTearOffControl + +RowColumn functions +XmGetTearOffControl + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmGetTearOffControl + +Widget menu + + + +DESCRIPTION +XmGetTearOffControl provides the application with the means for +obtaining the widget ID of the internally created tear-off control in a +tear-off menu. + +RowColumn creates a tear-off control for a PulldownMenu or PopupMenu +when the XmNtearOffModel resource is initialized or set to +XmTEAR_OFF_ENABLED. +The tear-off control is a widget that appears as the first element in +the menu. +The user tears off the menu by means of mouse or keyboard events in the +tear-off control. + +The tear-off control has Separator-like behavior. +Once the application has obtained the widget ID of the tear-off control, +it can set resources to specify the appearance of the control. +The application or user can also set these resources in a resource file +by using the name of the control, which is TearOffControl. +For a list of the resources the application or user can set, see +&cdeman.XmRowColumn;. + + + +menu + +Specifies the widget ID of the RowColumn PulldownMenu or PopupMenu + + + + +For more information on tear-off menus and a complete definition of +RowColumn and its associated resources, see &cdeman.XmRowColumn;. + + + +RETURN +Returns the widget ID for the tear-off control, or NULL if no tear-off +control exists. +An application should not assume that the returned widget will be of any +particular class. + + + +RELATED +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetVisi.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetVisi.sgm new file mode 100644 index 00000000..f8e7183e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetVisi.sgm @@ -0,0 +1,126 @@ + + + + + + + + + + + +XmGetVisibility +library call + + +XmGetVisibility +A function that determines if a widget is +visible + +XmGetVisibility + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmVisibility XmGetVisibility + +Widget widget + + + +DESCRIPTION +XmGetVisibility returns the visibility state of the specified +widget. +It checks to see if some part of the widget's rectangular +area is unobscured +by the widget's ancestors, or some part of the widget's rectangular +area is inside the work window (but possibly outside the clip window) +of a ScrolledWindow whose XmNscrollingPolicy is +XmAUTOMATIC and whose XmNtraverseObscuredCallback is not +NULL. + +XmGetVisibility does not check to see if widget is obscured by +its siblings or by siblings of its ancestors. Consequently, XmGetVisibility +returns XmVISIBILITY_UNOBSCURED for widgets which are completely or partially +covered by one or more siblings of widget by one or more siblings of ancestors +of widget. + +When a widget which is unrealized is being queried, it is indicated +that the widget is fully obscured. +If an application unmaps a widget that has its +XmNmappedWhenManaged resource set to True, the return value +is undefined. +When a widget which is unmanaged is being queried, it is +indicated that the widget is fully obscured. + + + +widget + +Specifies the ID of the widget + + + + + + +RETURN +Returns one of the following values: + + + +XmVISIBILITY_UNOBSCURED + +Indicates that the widget is mapped, not obscured, and is completely +visible on the screen. + + + + +XmVISIBILITY_PARTIALLY_OBSCURED + +Indicates that the widget is mapped, and is not completely +visible on the screen (partially obscured). + + + + +XmVISIBILITY_FULLY_OBSCURED + +Indicates that the widget is not at all visible on the screen. + + + + + + +RELATED +&cdeman.XmIsTraversable;, +&cdeman.XmManager;, +and &cdeman.XmProcessTraversal;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmD.sgm new file mode 100644 index 00000000..874fea53 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmD.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + + +XmGetXmDisplay +library call + + +XmGetXmDisplay +A Display function that returns the +XmDisplay object ID for a specified display + +XmGetXmDisplay + +Display functions +XmGetXmDisplay + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Display.h> + +Widget XmGetXmDisplay + +Display *display + + + +DESCRIPTION +XmGetXmDisplay returns the XmDisplay object ID associated +with a display. The application can access +Display resources with XtGetValues. + + + +display + +Specifies the display for which the XmDisplay object ID is to be returned + + + + +For a complete definition of Display and its associated resources, +see &cdeman.XmDisplay;. + + + +RETURN +Returns the XmDisplay object ID for the specified display. + + + +RELATED +&cdeman.XmDisplay;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmScr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmScr.sgm new file mode 100644 index 00000000..c198e88d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/GetXmScr.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmGetXmScreen +library call + + +XmGetXmScreen +A Screen function that returns the XmScreen object +ID for a specified screen + +XmGetXmScreen + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Screen.h> + +Widget XmGetXmScreen + +Screen *screen + + + +DESCRIPTION +XmGetXmScreen returns the XmScreen object ID associated +with a screen. The application can access +and manipulate Screen resources with XtGetValues and +XtSetValues. + + + +screen + +Specifies the screen for which the XmScreen ID is to be returned + + + + +For a complete definition of Screen and its associated resources, +see &cdeman.XmScreen;. + + + +RETURN +Returns the XmScreen object ID. + + + +RELATED +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IconGadg.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IconGadg.sgm new file mode 100644 index 00000000..84e84d43 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IconGadg.sgm @@ -0,0 +1,707 @@ + + + + + + + + + + +XmIconGadget +library call + + +XmIconGadget +The IconGadget widget class + +XmIconGadget + +iconGadget +IconGadget + + + +#include <Xm/IconG.h> + + + +DESCRIPTION +IconGadget is an instantiable widget used to display both text and a pixmap +in various combinations. +Other widgets that hold the XmQTcontainer trait, such as +Container, can use IconGadget to represent objects. + +IconGadget text is a compound string. If no text is supplied, then +the compound string is generated from the gadget name. IconGadget +text is placed relative to the type of associated pixmap. + +Depending upon the XmNviewType resource, IconGadget can display +two views: + + + +XmLARGE_ICON + +The IconGadget text string is displayed below the +pixmap, and centered. + + + + +XmSMALL_ICON + +The IconGadget text string is placed on the side of the small icon, in the +widget's XmNlayoutDirection. + + + + +A bitmap mask can be supplied for each pixmap to +clip the pixmap into some shape other than a rectangle. The +XmNlargeIconMask and XmNsmallIconMask resources specify +the large and small bitmap masks respectively. Visual emphasis for +the IconGadget is +provided with the XmNvisualEmphasis resource. +IconGadget's XmNdetail and XmNdetailCount resources provide +a detail view for IconGadgets, enabling the display of Strings alongside the +IconGadget. The exact layout ordering of the strings depends on the +associated containing widget. + +IconGadget uses the XmQTcontainer and +XmQTspecifyRenderTable traits, and +holds the XmQTcareParentVisual and XmQTcontainerItem traits. + + +Classes +IconGadget inherits behaviour, resources, and traits from Object, +RectObject, +and XmGadget classes. + +The class pointer is xmIconGadgetClass. + +The class name is XmIconGadget. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in a .Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in a .Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate whether the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + +XmIconGadget Resource Set + + +Name +Class +Type +Default +Access + + +Xmalignment +XmCAlignment +unsigned char +XmALIGNMENT_CENTER +CSG + + +XmNdetail +XmCDetail +XmStringTable +NULL +CSG + + +XmNdetailCount +XmCDetailCount +Cardinal +0 +CSG + + +XmNfontList +XmCFontList +XmFontList +NULL +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlargeIconMask +XmCIconMask +Pixmap +dynamic +CSG + + +XmNlargeIconPixmap +XmCIconPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNsmallIconMask +XmCIconMask +Pixmap +dynamic +CSG + + +XmNsmallIconPixmap +XmCIconPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNviewType +XmCViewType +unsigned char +XmLARGE_ICON +CSG + + +XmNvisualEmphasis +XmCVisualEmphasis +unsigned char +XmNOT_SELECTED +CSG + + +XmNspacing +XmCSpacing +Dimension +4 +CSG + + + + + + +XmNalignment + +Specifies the horizontal alignment of the pixmap with +respect to the label when the icon is in +LARGE_ICON +view. Valid values are +XmALIGNMENT_BEGINNING, +XmALIGNMENT_CENTER, +and XmALIGNMENT_END. + + + + +XmNdetail + +Specifies an array of XmStrings that are the detail information +associated with the gadget. + + + + +XmNdetailCount + +Specifies the size of the XmNdetail array. + + + + +XmNfontList + +Specifies the font list associated with XmIconGadget. The font list +is an obsolete construct, and has been superseded by the render table. +It is included for compatibility with earlier versions of Motif, and +for applications that do not easily support render tables. The +default font list is derived from the default render table, and if +both a font list and a render table are specified, the render table +takes precedence. + + + + +XmNlabelString + +Specifies the compound string. +If this value is NULL, it is initialized by converting the name of the +gadget to a compound string. +Refer to &cdeman.XmString; +for more information on the +creation and structure of compound strings. + + + + +XmNlargeIconMask + +Specifies the icon mask used when XmNviewType is XmLARGE_ICON. + + + + +XmNlargeIconPixmap + +Specifies the pixmap when XmNviewType is XmLARGE_ICON. If +this resource's value is XmUNSPECIFIED_PIXMAP, there is no +pixmap. If a large +icon pixmap is specified, and if during conversion an associated mask +can be fetched, then the +XmNlargeIconMask resource is set to that mask. + + + + +XmNmarginHeight + +Specifies the amount of vertical space between the highlight +and the inside (pixmap and label). + + + + +XmNmarginWidth + +Specifies the amount of horizontal space between the highlight +and the inside (pixmap and label). + + + + +XmNrenderTable + +Specifies the XmRenderTable of the text used in the gadget. +If XmNrenderTable is NULL when the IconGadget is created, the parent's +render table resource value is used if there is a render table. If +the parent does not have a render table, +the parent hierarchy of the widget is +searched for a widget that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the render table is initialized to the +XmLABEL_RENDER_TABLE value of the ancestor widget. If no such widget +is found, the default is implementation dependent. +Refer to +&cdeman.XmRenderTable; for more information on the creation and +structure of a XmRenderTable. +If both a render table and a font list are specified, the render table +will take precedence. + + + + +XmNsmallIconMask + +Specifies the icon mask used when XmNviewType is XmSMALL_ICON. + + + + +XmNsmallIconPixmap + +Specifies the pixmap when XmNviewType is XmSMALL_ICON. +If +this resource's value is XmUNSPECIFIED_PIXMAP, there is no +pixmap. If a small +icon pixmap is specified, and if during conversion an associated mask +can be fetched, then the +XmNsmallIconMask resource is set to that mask. + + + + +XmNspacing + +Specifies the amount of space between the pixmap and +the label parts of the icon. + + + + +XmNviewType + +Specifies the view (combination of pixmaps/text) that will be displayed. +If the IconGadget is a child of a Container widget, however, then the +specification of this resource will be taken from the Container— +if Container's XmNentryViewType is either XmLARGE_ICON or +XmSMALL_ICON, then IconGadget's XmNviewType takes that value; +otherwise, the default is XmLARGE_ICON. +This resource is set to one of the following: + + + +XmLARGE_ICON + +The pixmap specified by XmNlargeIconPixmap is +displayed with the XmNlabelString beneath it. + + + + +XmSMALL_ICON + +The pixmap specified by XmNsmallIconPixmap is +displayed with the XmNlabelString displayed in the direction of the +XmNlayoutDirection resource. + + + + + + + +XmNvisualEmphasis + +Specifies the visual state of the IconGadget. If the IconGadget is in a +selected state +all visuals are displayed using the Container XmNselectColor +resource. +It is set to one of the following: + + + +XmSELECTED + +The IconGadget is in the selected state and displays +the appropriate visuals. + + + + +XmNOT_SELECTED + +The IconGadget is not in the selected state. + + + + + + + + + +Inherited Resources +IconGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +False +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Additional Behavior +IconGadget has no behavior. + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + +Errors/Warnings +The toolkit will display a warning if an incorrect value is given +for an enumeration resource. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmContainer;, +&cdeman.XmCreateIconGadget;, and +&cdeman.XmGadget;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImCloXI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImCloXI.sgm new file mode 100644 index 00000000..a9412bd2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImCloXI.sgm @@ -0,0 +1,66 @@ + + + + + + + + + + + +XmImCloseXIM +library call + + +XmImCloseXIM +An input manager function that releases the input +method associated with a specified widget + +XmImCloseXIM + +input manager functions +XmImCloseXIM + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImCloseXIM + +Widget widget + + + +DESCRIPTION +XmImCloseXIM closes all input contexts associated with the Input +Method (IM) of widget. widget is used to +identify the Display that specifies the Input Method opened for the +widget. Upon closure, all widgets registered with the input contexts +are unregistered. Also, the Input Method specified by Display is closed. + + + +widget + +Specifies the ID of a widget whose reference Input Method is to be closed. + + + + + + +RELATED +&cdeman.XmImGetXIM; and +&cdeman.XmImRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImFrXIC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImFrXIC.sgm new file mode 100644 index 00000000..a7f18e8b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImFrXIC.sgm @@ -0,0 +1,76 @@ + + + + + + + + + + + +XmImFreeXIC +library call + + +XmImFreeXIC +An input manager function that unregisters widgets for an XIC + +XmImFreeXIC + +input manager functions +XmImFreeXIC + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImFreeXIC + +Widget widget +XIC xic + + + +DESCRIPTION +XmImFreeXIC unregisters all widgets associated with the specified +X Input Context (XIC). +The specified widget must be associated with the specified +xic. + +After unregistering the associated widgets, this call +frees the xic. + + + +widget + +Specifies the ID of a widget used to identify the VendorShell +and XmDisplay that maintain the widget-XIC registry. + + + + +xic + +Specifies the Input Context associated with the widget. + + + + + + +RELATED +&cdeman.XmImGetXIC; and +&cdeman.XmImSetXIC;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIC.sgm new file mode 100644 index 00000000..840f9ec1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIC.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmImGetXIC +library call + + +XmImGetXIC +An input manager function that obtains an XIC for a widget + +XmImGetXIC + +input manager functions +XmImGetXIC + + + + + + + + + + +#include <Xm/XmIm.h> + +XIC XmImGetXIC + +Widget widget +XmInputPolicy input_policy +ArgList args +Cardinal num_args + + + +DESCRIPTION +XmImGetXIC creates and registers an X Input Context (XIC) +with the specified +arguments for widget. If XmINHERIT_POLICY is specified +for input_policy, a new XIC will be created only if +required to by the arguments or by the VendorShell input policy. +Any existing XIC registered with widget is unregistered. + +Refer to the VendorShell reference page for further details. + + + +widget + +Specifies the ID of a widget for which an Input Context is to be +created. + + + + +input_policy + +Specifies the type of input policy. It accepts the following values: + + + +XmINHERIT_POLICY + +Inherits the policy from VendorShell. + + + + +XmPER_WIDGET + +Creates a new XIC for this widget. + + + + +XmPER_SHELL + +Creates a new XIC for the shell, if needed. + + + + + + + +args + +Specifies an XtArgList parameter to use for creating the XIC. + + + + +num_args + +Specifies the number of arguments in the args parameter. + + + + + + +RETURN +Returns the created XIC. +The application is responsible for freeing the returned XIC +by calling XmImFreeXIC. + + + +RELATED +&cdeman.XmImSetXIC; and +&cdeman.XmImFreeXIC;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIM.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIM.sgm new file mode 100644 index 00000000..c556abd0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImGetXIM.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmImGetXIM +library call + + +XmImGetXIM +An input manager function that retrieves the input +method associated with a specified widget + +XmImGetXIM + +input manager functions +XmImGetXIM + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +XIM XmImGetXIM + +Widget widget + + + +DESCRIPTION +XmImGetXIM retrieves the XIM data structure representing +the input method that the input manager has opened for the +specified widget. If an input method has not been opened +by a previous call to XmImRegister, the first time this +routine is called it opens an input method using the +XmNinputMethod resource for the VendorShell. If the +XmNinputMethod is NULL, an input method is opened using the +current locale. +If it cannot open an input method, the +function returns NULL. + + + +widget + +Specifies the ID of a widget registered with the input manager + + + + + + +RETURN +Returns the input method for the current locale associated with +the specified widget's input manager; otherwise, returns NULL. +The application is responsible for freeing the returned XIM by calling +XmImCloseXIM. + + + +RELATED +&cdeman.XmImCloseXIM;, +&cdeman.XmImGetXIM;, +&cdeman.XmImMbLookupString;, and +&cdeman.XmImRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbLook.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbLook.sgm new file mode 100644 index 00000000..30552bae --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbLook.sgm @@ -0,0 +1,186 @@ + + + + + + + + + + + +XmImMbLookupString +library call + + +XmImMbLookupString +An input manager function that retrieves a composed string from an input method + +XmImMbLookupString + +input manager functions +XmImMbLookupString + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +int XmImMbLookupString + +Widget widget +XKeyPressedEvent *event +char *buffer_return +int bytes_buffer +KeySym *keysym_return +int *status_return + + + +DESCRIPTION +XmImMbLookupString returns a string composed in the +locale associated with the widget's input method and a +KeySym that is currently mapped to the keycode in a KeyPress +event. The KeySym is obtained by using the standard +interpretation of Shift, Lock and Group modifiers as +defined in the X Protocol specification. + +An XIM will be created, but an XIC will not be created. One of the functions, +XmImSetValues, XmImVaSetValues, or XmImGetXIC, +needs to be called to create an XIC. + + + +widget + +Specifies the ID of the widget registered with the input manager + + + + +event + +Specifies the key press event + + + + +buffer_return + +Specifies the buffer in which the string is returned + + + + +bytes_buffer + +Specifies the size of the buffer in bytes + + + + +keysym_return + +Specifies a pointer to the KeySym returned if one exists + + + + +status_return + +Specifies the status values returned by the function. These status +values are the same as those for the XmbLookupString function. The +possible status values are: + + + +XBufferOverflow + +The size of the buffer was insufficient to handle +the returned string. The contents of buffer_return +and keysym_return are not modified. The required +buffer size is returned as a value of the function. The +client should repeat the call with a larger buffer size to +receive the string. + + + + +XLookupNone + +No consistent input was composed. The contents of +buffer_return and keysym_return are not modified +and the function returns a value of 0. + + + + +XLookupChars + +Some input characters were composed and returned in +buffer_return. The content of keysym_return +is not modified. The function returns the length of +the string in bytes. + + + + +XLookupKeysym + +A keysym value was returned instead of a string. The content of +buffer_return is not modified and the function returns +a value of 0. + + + + +XLookupBoth + +A keysym value and a string were returned. The keysym value may +not necessarily correspond to the string returned. The function +returns the length of the string in bytes. + + + + + + + + + +RETURN +Return values depend on the status returned by the function. Refer +to the description of status values above. + + + +RELATED +&cdeman.XmImGetXIM;, +&cdeman.XmImGetXIC;, +&cdeman.XmImRegister;, +&cdeman.XmImSetValues;, +and +&cdeman.XmImUnregister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbRese.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbRese.sgm new file mode 100644 index 00000000..01aff168 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImMbRese.sgm @@ -0,0 +1,61 @@ + + + + + + + + + + +XmImMbResetIC +library call + + +XmImMbResetIC + +An input manager function that resets the input context for a widget + + + + +#include <Xm/XmIm.h> + +void XmImMbResetIC +Widget widget +char **mb + + + +DESCRIPTION +XmImMbResetIC gets the XIC of the widget +and resets it. It puts a pointer to a string +containing the current preedit string to mb. The caller should free the returned +string after use by calling Xfree. + + +widget + +Specifies the ID of the widget. + + + +mb + +Contains a pointer to the preedit string upon return. + + + + + + +RETURN VALUE +None + + + +SEE ALSO + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImRegist.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImRegist.sgm new file mode 100644 index 00000000..338c18cc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImRegist.sgm @@ -0,0 +1,103 @@ + + + + + + + + + + + +XmImRegister +library call + + +XmImRegister +An input manager function that registers a widget with an input manager + +XmImRegister + +input manager functions +XmImRegister + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImRegister + +Widget widget +unsigned int reserved + + + +DESCRIPTION +XmImRegister registers a widget with its input manager. +This adds the specified widget to a list of widgets that +are supported by the input manager for an input method. +If an input method has not been opened +by a previous call to XmImRegister, the first time this +routine is called it opens an input method using the +XmNinputMethod resource for the VendorShell. If the +XmNinputMethod is NULL, an input method is opened using the +current locale. + +If an input method cannot be opened in +the current locale, XLookupString provides input processing. + +The application is responsible for unregistering a widget by calling +XmImUnregister. + +Note that the Text, TextField, and List widgets already call the +XmImRegister function internally. You should not call this function for +these widgets before calling XmImUnregister first. + + + +widget + +Specifies the ID of the widget to be registered. + + + + +reserved + +This argument is not used in the current release of Motif. +The value should always be 0 (zero). + + + + + + +RELATED +&cdeman.XmImGetXIM;, +&cdeman.XmImMbLookupString;, +and &cdeman.XmImUnregister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetFoc.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetFoc.sgm new file mode 100644 index 00000000..299cc903 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetFoc.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmImSetFocusValues +library call + + +XmImSetFocusValues +An input manager function that notifies an input manager that a widget +has received input focus and updates the input context attributes + +XmImSetFocusValues + +input manager functions +XmImSetFocusValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImSetFocusValues + +Widget widget +ArgList arglist +Cardinal argcount + + + + +DESCRIPTION +XmImSetFocusValues notifies the input manager that the +specified widget has received input focus. This function also updates the +attributes of the input context associated with the widget. The focus +window for the XIC is set to the window of the widget. The +arglist argument is a list of attribute/value pairs for the input +context. This function passes the attributes and values to +XICSetValues. The caller of this routine should pass in +only those values that have changed since the last call to any of +these functions; XmImSetValues, XmImSetFocusValues, +XmImVaSetValues, or XmImVaSetFocusValues. See the +description in the &cdeman.XmImSetValues; reference page for a list of +associated resources. + +If the previous parameters for the widget's XIC do not allow +the previously registered XIC to be reused, that XIC will be +unregistered, and a new one will be created and registered with the +widget. Note that sharing of data is preserved. + + + +widget + +Specifies the ID of the widget registered with the input manager. + + + + +arglist + +Specifies the list of attribute/value pairs to be passed to +XICSetValues. See the description in the &cdeman.XmImSetValues; +man page for a description of resources. + + + + +argcount + +Specifies the number of attribute/values pairs in the argument +list (arglist) + + + + +Note that the Text and TextField widgets call the +XmImSetFocusValues function when they receive focus. Therefore, +further calls to the XmImSetFocusValues function for these +widgets are unnecessary. + + + +RELATED +&cdeman.XmImSetValues;, +&cdeman.XmImVaSetFocusValues;, and +&cdeman.XmImVaSetValues;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetVal.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetVal.sgm new file mode 100644 index 00000000..d05324e2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetVal.sgm @@ -0,0 +1,172 @@ + + + + + + + + + + +XmImSetValues +library call + + +XmImSetValues +An input manager function that updates attributes of +an input context + +XmImSetValues + +input manager functions +XmImSetValues + + + + +#include <Xm/XmIm.h> + +void XmImSetValues +Widget widget +ArgList arglist +Cardinal argcount + + + + +DESCRIPTION +XmImSetValues updates attributes of the input context associated with +the specified widget. The arglist argument is a list of +attribute/value pairs for the input context. This function passes the +attributes and values to XICSetValues. The initial call to +this routine should pass in all of the input context attributes. +Thereafter, the application programmer calls XmImSetValues, for +an XIC, +only if a value has changed. + +If the previous parameters for the widget's XIC do not allow +the previously registered XIC to be reused, that XIC will be +unregistered, and a new one will be created and registered with the +widget. Note that sharing of data is preserved. + +Note that the Text and TextField widgets call the +XmImSetValues function when they receive focus. Therefore, +further calls to the XmImSetValues function for these +widgets are unnecessary. + + + +widget + +Specifies the ID of the widget registered with the input manager + + + + +arglist + +Specifies the list of attribute/value pairs to be passed to XICSetValues; +the following attributes are accepted: +XmNpreeditStartCallback +XmNpreeditDoneCallback +XmNpreeditDrawCallback +and +XmNpreeditCaretCallback. These attributes accept an accompanying +value of type pointer +to structure of type XIMCallback. + +These callbacks are used only when the XmNpreeditType +resource of the relevant VendorShell has the "onthespot" value, +and that the XIM supports XIMPreeditCallbacks input style. These +values are ignored if the condition is not met. + +For each of these callbacks, if the callback value is not set by this +function, no action will be taken when the Input Method tries to call this callback. +Refer to the "Xlib - C Language X Interface, X Version 11, Release 6," +Chapter 13 for the detail of these callbacks. + + + + +argcount + +Specifies the number of attribute/values pairs in the argument +list (arglist) + + + + +Resources that can be set for the input context include: + + + +XmNbackground + +Specifies the pixel value for the background color. + + + + +XmNbackgroundPixmap + +Specifies a pixmap for tiling the background. + + + + +XmNfontList + +Specifies the font list used by the widget. The input method +uses the first occurrence of a font set tagged with +XmFONTLIST_DEFAULT_TAG. If no such instance is +found, the first font set in the font list is used. If +the font list does not contain a font set, a value is not +passed to XICSetValues. + + + + +XmNforeground + +Specifies the pixel value for the foreground color. + + + + +XmNlineSpace + +Specifies the line spacing used in the pre-edit window. + + + + +XmNrenderTable + +Specifies the render table used by the widget. + + + + +XmNspotLocation + +Specifies the x and y coordinates of the position +where text will be inserted in the widget handling +input, whose input method style is "OverTheSpot". The y +coordinate is the position of the baseline used by the current text line. + + + + +The caller may also pass any other vendor-defined resources to this +function. For additional information on the internationalization +interface, see the Xlib documentation. + + + +RELATED +&cdeman.XmImSetFocusValues;, +&cdeman.XmImVaSetFocusValues;, and +&cdeman.XmImVaSetValues;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetXIC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetXIC.sgm new file mode 100644 index 00000000..8d8837bf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImSetXIC.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + + +XmImSetXIC +library call + + +XmImSetXIC +An input manager function that registers an existing XIC with a widget + +XmImSetXIC + +input manager functions +XmImSetXIC + + + + + + + + + + +#include <Xm/XmIm.h> + +XIC XmImSetXIC + +Widget widget +XIC xic + + + +DESCRIPTION +XmImSetXIC registers the specified X Input Context (XIC) with +widget. Any existing XIC registered for widget is +unregistered. The new XIC registered for widget is returned. + +If xic was not created by XmImGetXIC or +XmImRegister, it will not be subject to closing activities when it +has no widgets registered with it. + + + +widget + +Specifies the ID of a widget for which a new Input Context is to be +registered. + + + + +xic + +Specifies the Input Context to be registered with the widget. +If xic is NULL, the function returns the current XIC +used by widget. + + + + + + +RETURN +Returns the new XIC registered for widget. +The application is responsible for freeing the returned XIC. +To free the XIC, call XmImFreeXIC. + + + +RELATED +&cdeman.XmImGetXIC; and +&cdeman.XmImFreeXIC;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnreg.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnreg.sgm new file mode 100644 index 00000000..ecbc2939 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnreg.sgm @@ -0,0 +1,81 @@ + + + + + + + + + + + +XmImUnregister +library call + + +XmImUnregister +An input manager function that removes a widget +from association with its input manager + +XmImUnregister + +input manager functions +XmImUnregister + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImUnregister + +Widget widget + + + +DESCRIPTION +XmImUnregister removes the specified widget from the list of +widgets registered for input by the input manager. + +Note that the Text, TextField, and List widgets already call the +XmImRegister internally. You should call the +XmImUnregister function for +these widgets before calling XmImRegister. + + + +widget + +Specifies the ID of the widget to be unregistered + + + + + + +RELATED +&cdeman.XmImRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnsetF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnsetF.sgm new file mode 100644 index 00000000..a4909f40 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImUnsetF.sgm @@ -0,0 +1,80 @@ + + + + + + + + + + + +XmImUnsetFocus +library call + + +XmImUnsetFocus +An input manager function that notifies an input +method that a widget has lost input focus + +XmImUnsetFocus + +input manager functions +XmImUnsetFocus + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImUnsetFocus + +Widget widget + + + +DESCRIPTION +XmImUnsetFocus unsets a specified widget's focus, then +notifies the input manager that the specified widget has lost its input focus. + +Note that the Text, TextField, and List widgets already call the +XmImUnsetFocus internally. Therefore, further calls to the +XmImUnsetFocus function for those widgets are unnecessary. + + + +widget + +Specifies the ID of the widget registered with the input manager + + + + + + +RELATED +&cdeman.XmImSetFocusValues; and &cdeman.XmImVaSetFocusValues;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetF.sgm new file mode 100644 index 00000000..846f212b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetF.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmImVaSetFocusValues +library call + + +XmImVaSetFocusValues +An input manager function that notifies an +input manager that a widget has received input focus and updates the input +context attributes + +XmImVaSetFocusValues + +input manager functions +XmImVaSetFocusValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImVaSetFocusValues + +Widget widget + + + +DESCRIPTION +XmImVaSetFocusValues notifies the input manager that the +specified widget has received input focus. This function also updates the +attributes of the input context associated with the widget. This +function passes the attributes and values to XICSetValues. The +caller of this routine should pass in only those values that have changed +since the last call to any of these functions; XmImVaSetValues, +XmImVaSetFocusValues, XmImSetValues, or XmImSetFocusValues. +See the description in the &cdeman.XmImSetValues; reference page for a list of +associated resources. + +This routine uses the ANSI C variable-length argument list (varargs) calling +conventions. The variable-length argument list consists of groups +of arguments each of which contains an attribute followed by the +value of the attribute. The last argument in the list must be NULL + +Note that the List and TextField widgets call the +XmImVaSetFocusValues function when they receive focus. Therefore, +further calls to the XmImVaSetFocusValues function for these +widgets are unnecessary. + + + +widget + +Specifies the ID of the widget registered with the input manager + + + + +For more information on variable-length argument lists, see the +X Toolkit Intrinsics documentation. + + + +RELATED +&cdeman.XmImSetFocusValues;, +&cdeman.XmImSetValues;, and +&cdeman.XmImVaSetValues;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetV.sgm new file mode 100644 index 00000000..c857bf00 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ImVaSetV.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + +XmImVaSetValues +library call + + +XmImVaSetValues +An input manager function that updates attributes +of an input context + +XmImVaSetValues + +input manager functions +XmImVaSetValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/XmIm.h> + +void XmImVaSetValues + +Widget widget + + + +DESCRIPTION +XmImVaSetValues updates attributes of the input context associated +with the specified widget. This function passes the attributes to +XICSetValues. The initial call to this routine should pass in +all of the input context attributes. Thereafter, the application +programmer calls XmImVaSetValues only if a value has changed. See +the description in the &cdeman.XmImSetValues; man page for a list of +associated resources. + +This routine uses the ANSI C variable-length +argument list (varargs) calling convention. The variable-length argument +list consists of groups of arguments each of which contains an attribute +followed by the value of the attribute. The last argument in the list must +be NULL. + +Note that the List and TextField widgets call the +XmImVaSetValues function internally. Therefore, +further calls to the XmImVaSetValues function for these +widgets are unnecessary. + + + +widget + +Specifies the ID of the widget registered with the input manager + + + + +For more information on variable-length argument lists, see +the X Toolkit Intrinsics documentation. + + + +RELATED +&cdeman.XmImSetFocusValues;, +&cdeman.XmImSetValues;, and +&cdeman.XmImVaSetFocusValues;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InstIm.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InstIm.sgm new file mode 100644 index 00000000..7392bcfe --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InstIm.sgm @@ -0,0 +1,163 @@ + + + + + + + + + + + +XmInstallImage +library call + + +XmInstallImage +A pixmap caching function that adds an image to the image cache + +XmInstallImage + +pixmaps + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmInstallImage + +XImage * image +char * image_name + + + +DESCRIPTION +XmInstallImage stores an image in an image cache +that can later be used to generate a pixmap. +Part of the installation process is to extend the +resource converter used to reference these images. The resource converter +is given the image name so that the image can be +referenced in a .Xdefaults file. +Since an image can be referenced by a widget +through its pixmap resources, it is up to the application to ensure that the +image is installed before the widget is created. + + + +image + +Points to the image structure to be installed. +The installation process does not make a local copy of the image. Therefore, +the application should not destroy the image until it is uninstalled from +the caching functions. + + + + +image_name + +Specifies a string that the application uses to name the image. After +installation, this name can be used in .Xdefaults for referencing +the image. A local copy of the name is created by the image caching +functions. + + + + +The image caching functions provide a set of eight preinstalled images. +These names can be used within a .Xdefaults file for generating pixmaps +for the resource for which they are provided. + + + + + + + +Image Name +Description + + +background +A tile of solid background + + +25_foreground +A tile of 25% foreground, 75% background + + +50_foreground +A tile of 50% foreground, 50% background + + +75_foreground +A tile of 75% foreground, 25% background + + +horizontal +A tile of horizontal lines of the two colors + + +vertical +A tile of vertical lines of the two colors + + +slant_right +A tile of slanting lines of the two colors + + +slant_left +A tile of slanting lines of the two colors + + +menu_cascade +A tile of an arrow of the foreground color + + +menu_checkmark +A tile of a checkmark of the foreground color + + +menu_dash +A tile of one horizontal line of the foreground color + + + + + + +RETURN +Returns True when successful; returns False if NULL image, NULL +image_name, or duplicate image_name is used as a parameter +value. + + + +RELATED +&cdeman.XmUninstallImage;, &cdeman.XmGetPixmap;, and +&cdeman.XmDestroyPixmap;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InternA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InternA.sgm new file mode 100644 index 00000000..afff156e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/InternA.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmInternAtom +library call + + +XmInternAtom +A macro that returns an atom for a given name + +XmInternAtom + +atoms + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/AtomMgr.h> + +Atom XmInternAtom + +Display * display +String name +Boolean only_if_exists + + + +DESCRIPTION +XmInternAtom returns an atom for a given name. +The returned atom remains defined even after the client's +connection closes. The returned atom becomes undefined when +the last connection to the X server closes. + + + +display + +Specifies the connection to the X server + + + + +name + +Specifies the name associated with the atom you want returned. +The value of name is case dependent. + + + + +only_if_exists + +Specifies a Boolean value. +If False, the atom is created even if it does not exist. +(If it does not exist, the returned atom will be None.) +If True, the atom is created only if it exists. + + + + + + +RETURN +Returns an atom. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsMWM.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsMWM.sgm new file mode 100644 index 00000000..1e96eeac --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsMWM.sgm @@ -0,0 +1,78 @@ + + + + + + + + + + + +XmIsMotifWMRunning +library call + + +XmIsMotifWMRunning +A function that determines whether the window manager is running + +XmIsMotifWMRunning + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmIsMotifWMRunning + +Widget shell + + + +DESCRIPTION +XmIsMotifWMRunning lets a user know +whether the Motif Window Manager is +running on a screen that contains a specific widget hierarchy. +This +function first sees whether the _MOTIF_WM_INFO property is present on +the root window of the shell's screen. If it is, its window +field is used to query for the presence of the specified window as a +child of root. + + + +shell + +Specifies the shell whose screen will be tested for mwm's presence. + + + + + + +RETURN +Returns True if MWM is running. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsTraver.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsTraver.sgm new file mode 100644 index 00000000..ab2b8dff --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/IsTraver.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmIsTraversable +library call + + +XmIsTraversable +A function that identifies whether a widget can +be traversed + +XmIsTraversable + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmIsTraversable + +Widget widget + + + +DESCRIPTION +XmIsTraversable determines whether the specified widget is +eligible to receive focus through keyboard traversal. +In general, a widget is eligible to receive focus when all of the +following conditions are true: + + + +The widget and its ancestors are not being destroyed, are sensitive, and +have a value of True for XmNtraversalOn. + + + +The widget and its ancestors are realized, managed, and (except for +gadgets) mapped. +If an application unmaps a widget that has its +XmNmappedWhenManaged resource set to True, the return value +is undefined. + + + +Some part of the widget's rectangular area is unobscured by the widget's +ancestors, or some part of the widget's rectangular area is inside the +work window (but possibly outside the clip window) of a ScrolledWindow +whose XmNscrollingPolicy is XmAUTOMATIC and whose +XmNtraverseObscuredCallback is not NULL. + + + +Some widgets may not be eligible to receive focus even if they meet all +these conditions. +For example, most managers cannot receive focus through keyboard traversal. +Some widgets may be eligible to receive focus under particular +conditions. +For example, a DrawingArea is eligible to receive focus if it meets the +conditions above and has no child whose XmNtraversalOn resource is +True. + +Note that when all widgets in a shell hierarchy have been made +untraversable, they are considered to have lost focus. When a +widget in this hierarchy is made traversable again, it regains focus. + +XmIsTraversable may return unexpected results when widget +or its ancestors are overlapped by their siblings. + + + +widget + +Specifies the ID of the widget + + + + + + +RETURN +Returns True if the widget is eligible to receive focus through keyboard +traversal; otherwise, returns False. + + + +RELATED +&cdeman.XmGetVisibility; and &cdeman.XmProcessTraversal;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Label.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Label.sgm new file mode 100644 index 00000000..83dd2948 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Label.sgm @@ -0,0 +1,1414 @@ + + + + + + + + + + + +XmLabel +library call + + +XmLabel +The Label widget class + +XmLabel + +widget class +Label + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Label.h> + + + +DESCRIPTION +Label is an instantiable widget and is also used as a superclass for +other button widgets, such as PushButton and ToggleButton. The Label +widget does not accept any button or key input, and the help +callback is the only callback defined. Label also receives enter +and leave events. + +Label can contain either text or a pixmap. Label text is a +compound string. Refer to the &MotifProgGd; +for more information on compound strings. +The text can be multilingual, +multiline, and/or multifont. When a Label is insensitive, its text is +stippled, or the user-supplied insensitive pixmap is displayed. + +Label supports both accelerators and mnemonics primarily for use in +Label subclass widgets that are contained in menus. +Mnemonics are available in a menu system when the button is visible. +Accelerators in a menu system are accessible even when the button is not +visible. +The Label widget displays the mnemonic by underlining the first matching +character in the text string. +The accelerator is displayed +as a text string adjacent to the label text or pixmap, depending on +the layout direction. + +Label consists of many margin fields surrounding the text or pixmap. +These margin fields are resources that may +be set by the user, but Label subclasses and Manager parents also +modify some of these fields. They tend to modify the +XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom resources and leave the XmNmarginWidth and +XmNmarginHeight resources as set by the application. + +Label takes into account XmNshadowThickness in determining +its layout but does not draw the shadow. That is, if XmNshadowThickness +is greater than 0 (zero), Label leaves space for the shadow, but the shadow +does not appear. + +In a Label, XmNtraversalOn and XmNhighlightOnEnter are forced +to False inside Popup menu panes, Pulldown menu panes, and OptionMenus. +Otherwise, these resources default to False. + +Label uses the XmQTmenuSystem and XmQTspecifyRenderTable +traits, and +holds the XmQTaccessTextual, XmQTmenuSavvy, and +XmQTtransfer traits. + + +Data Transfer Behavior +Label and it subclasses, except when used in a menu system, support +dragging of the label contents from the Label. +However, the label contents are draggable only if +the XmNenableUnselectableDrag resource of XmDisplay +is set to True. + +As a source of data, Label and its subclasses support the following +targets and associated conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers XmNlabelString in the encoding of the locale. +This target is supported only when XmNlabelType is XmSTRING. + + + + +COMPOUND_TEXT + +The widget transfers XmNlabelString as type COMPOUND_TEXT. +This target is supported only when XmNlabelType is XmSTRING. + + + + +PIXMAP + +The widget transfers XmNlabelPixmap as type DRAWABLE. +This target is supported only when XmNlabelType is XmPIXMAP. + + + + +STRING + +The widget transfers XmNlabelString as type STRING. +This target is supported only when XmNlabelType is XmSTRING. + + + + +TEXT + +If XmNlabelString is fully convertible to the encoding of the +locale, the widget transfers XmNlabelString in the encoding of +the locale. +Otherwise, the widget transfers XmNlabelString as type +COMPOUND_TEXT. +This target is supported only when XmNlabelType is XmSTRING. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for the CLIPBOARD selection. +When XmNlabelType is XmSTRING, these include the following +targets: + + + +_MOTIF_COMPOUND_STRING + + + +COMPOUND_TEXT + + + +The encoding of the locale, if XmNlabelString is fully convertible +to the encoding of the locale + + + +STRING, if XmNlabelString is fully convertible to +STRING + + + +When XmNlabelType is XmPIXMAP, the targets include +PIXMAP. + + + + +_MOTIF_COMPOUND_STRING + +The widget transfers XmNlabelString as a compound string in +Byte Stream format. +This target is supported only when XmNlabelType is XmSTRING. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +When XmNlabelType is XmSTRING, these include +_MOTIF_COMPOUND_STRING, COMPOUND_TEXT, the encoding of the +locale, STRING, TEXT, BACKGROUND, and +FOREGROUND. +When XmNlabelType is XmPIXMAP, these include PIXMAP, +BACKGROUND, and FOREGROUND. + + + + +As a source of data, Label also supports the following standard Motif +targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +When XmNlabelType is XmSTRING, these also include +_MOTIF_COMPOUND_STRING, COMPOUND_TEXT, the encoding of the +locale, STRING, and TEXT. +When XmNlabelType is XmPIXMAP, these also include +PIXMAP. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + + + +Classes +Label inherits behavior, resources, and traits from +Core and XmPrimitive. + +The class pointer is xmLabelWidgetClass. + +The class name is XmLabel. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), +or is not applicable (N/A). + + + + + + + + + + + +XmLabel Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +0 +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +0 +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +0 +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +0 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + +XmNaccelerator + +Sets the accelerator on a button widget in a menu, which +activates a visible or invisible, but managed, button from the keyboard. +This resource is a string that describes a set of modifiers +and the key that may be used to select the button. +The format of this string +is identical to that used by the translations manager, with the exception +that only a single event may be specified and only KeyPress events are +allowed. + +Accelerators for buttons are supported only for +PushButtons and ToggleButtons in Pulldown and Popup menu panes. + + + + +XmNacceleratorText + +Specifies the text displayed +for the accelerator. +The text is displayed +adjacent to the label string or pixmap. The direction of its layout depends on +the XmNlayoutDirection resource of the widget. +Accelerator text for buttons is displayed only for +PushButtons and ToggleButtons in Pulldown and Popup Menus. + + + + +XmNalignment + +Specifies the label alignment for text or pixmap. + + + +XmALIGNMENT_BEGINNING (left alignment) + +Causes the left sides of +the lines of text to be vertically aligned with the +left edge of the widget window. For a pixmap, its left side is vertically +aligned with the left edge of the widget window. + + + + +XmALIGNMENT_CENTER (center alignment) + +Causes the centers of the lines of text to be vertically aligned +in the center of the widget window. For a pixmap, its center is vertically aligned with the +center of the widget window. + + + + +XmALIGNMENT_END (right alignment) + +Causes the right sides of the +lines of text to be vertically aligned with the +right edge of the widget window. For a pixmap, its right side is vertically +aligned with the right edge of the widget window. + + + + +The preceding descriptions for text are correct when +XmNlayoutDirection is XmLEFT_TO_RIGHT. When that resource +is XmRIGHT_TO_LEFT, the descriptions for +XmALIGNMENT_BEGINNING and XmALIGNMENT_END are switched. + +If the parent is a RowColumn whose XmNisAligned resource is True, +XmNalignment is forced to the same value as the RowColumn's +XmNentryAlignment if the RowColumn's XmNrowColumnType is +XmWORK_AREA or if the widget is a subclass of XmLabel. +Otherwise, the default is XmALIGNMENT_CENTER. + + + + +XmNfontList + +Specifies the font of the text used in the widget. XmNfontList +is obsolete and exists for compatibility with previous releases. You +should now use XmNrenderTable instead of XmNfontList. If +both are specified, the render table will take precedence. If +XmNfontList is NULL at initialization, Label searches its parent +hierarchy for an ancestor that is a subclass of the XmBulletinBoard, +VendorShell, or XmMenuShell widget class. If such an ancestor is +found, Label initializes XmNfontList to the +XmNlabelFontList of the ancestor widget. Similarly, button +subclasses of Label initialize XmNfontList to the +XmNbuttonFontList of the ancestor widget. (Currently, all +subclasses of Label are button subclasses.) If no such ancestor is +found, the default is implementation dependent. Refer to +&cdeman.XmFontList; for more information on the creation and +structure of a font list. + + + + +XmNlabelInsensitivePixmap + +Specifies a pixmap used as the button face if XmNlabelType is +XmPIXMAP and the button is insensitive. +The default value, XmUNSPECIFIED_PIXMAP, displays an empty label. + + + + +XmNlabelPixmap + +Specifies the pixmap when XmNlabelType is +XmPIXMAP. +The default value, XmUNSPECIFIED_PIXMAP, displays an empty label. + + + + +XmNlabelString + +Specifies the compound string when XmNlabelType is +XmSTRING. +If this value is NULL, it is initialized by converting the name +of the widget to a compound string. +Refer to &cdeman.XmString; +for more information on the +creation and structure of compound strings. + + + + +XmNlabelType + +Specifies the label type. + + + +XmSTRING + +Displays text using XmNlabelString. + + + + +XmPIXMAP + +Displays pixmap using XmNlabelPixmap or +XmNlabelInsensitivePixmap. + + + + + + + +XmNmarginBottom + +Specifies the amount of spacing between the bottom of the label text +and the top of the bottom margin specified by XmNmarginHeight. +This may be modified by Label's +subclasses. For example, CascadeButton may increase this field to make +room for the cascade pixmap. + + + + +XmNmarginHeight + +Specifies an equal amount of spacing above the margin +defined by XmNmarginTop and below the margin defined by +XmNmarginBottom. XmNmarginHeight specifies the amount +of spacing between the top edge of the margin set by XmNmarginTop +and the bottom edge of the top shadow, and the amount of spacing between +the bottom edge of the margin specified by XmNmarginBottom and the +top edge of the bottom shadow. + + + + +XmNmarginLeft + +Specifies the amount of spacing between the left edge of the label text +and the right side of the left margin (specified by XmNmarginWidth). +This may be modified by Label's +subclasses. For example, ToggleButton may increase this field to make room +for the toggle indicator and for spacing between the indicator and label. +Whether this actually applies to the left or right side of the label +depends on the value of +the XmNlayoutDirection resource. + + + + +XmNmarginRight + +Specifies the amount of spacing between the right edge of the label text +and the left side of the right margin (specified by XmNmarginWidth). +This may be modified by Label's +subclasses. For example, CascadeButton may increase this field to make room +for the cascade pixmap. +Whether this actually applies to the left or right side of the label +depends on the value of +the XmNlayoutDirection resource. + + + + +XmNmarginTop + +Specifies the amount of spacing between the top of the label text and +the bottom of the top margin specified by XmNmarginHeight. +This may be modified by Label's subclasses. For example, CascadeButton +may increase this field to make room for the cascade pixmap. + + + + +XmNmarginWidth + +Specifies an equal amount of spacing to the left of the margin defined +by XmNmarginLeft and to the right of the margin defined by +XmNmarginRight. XmNmarginWidth specifies the amount +of spacing between the left edge of the margin set by XmNmarginLeft +and the right edge of the left shadow, and the amount of spacing between +the right edge of the margin specified by XmNmarginRight and the +left edge of the right shadow. + + + + +XmNmnemonic + +Provides the user with an alternate means of activating a button. +A button in a MenuBar, a Popup menu pane, or a Pulldown +menu pane can have a mnemonic. + +This resource contains a keysym as listed in the X11 keysym table. +The first character in the label string that exactly matches +the mnemonic in the character set specified in +XmNmnemonicCharSet +is underlined when the button is displayed. + +When a mnemonic has been specified, the user activates the button by +pressing the mnemonic key while the button is visible. +If the button is a CascadeButton in a MenuBar and the MenuBar does not +have the focus, the user must use the MAlt modifier while +pressing the mnemonic. +The user can activate the button by pressing either the shifted or the +unshifted mnemonic key. + + + + +XmNmnemonicCharSet + +Specifies the character set of the mnemonic for the label. +The default is XmFONTLIST_DEFAULT_TAG. + + + + +XmNrecomputeSize + +Specifies a Boolean value that indicates whether the widget +shrinks or expands to accommodate its contents (label string or +pixmap) as a result of an XtSetValues resource value that +would change the size of the widget. If True, the widget shrinks +or expands to exactly fit the label string or pixmap. +If False, the widget never attempts to change size on its own. + + + + +XmNrenderTable + +Specifies the render table associated with the labelString. If +this value is NULL at initialization, Label searches its parent +hierarchy for an ancestor that holds the XmQTspecifyRenderTable trait. +If such an ancestor is +found, Label initializes XmNrenderTable to the +XmLABEL_RENDER_TABLE value of the ancestor widget. Similarly, button +subclasses of Label initialize XmNrenderTable to the +XmBUTTON_RENDER_TABLE value of the ancestor widget. (Note that all +current subclasses of Label are button subclasses.) If no such +ancestor is found, the default is implementation dependent. If a font +list and a render table are both sepcified, the render table will take +precedence. Refer to &cdeman.XmRenderTable; for more information on +the creation and structure of a render table. + + + + +XmNstringDirection + +Is a synthetic resource for setting XmNlayoutDirection. +The values for this resource are XmSTRING_DIRECTION_L_TO_R and +XmSTRING_DIRECTION_R_TO_L. Refer to the +XmNlayoutDirection resource description. The +XmNstringDirection resource is obsoleted by +XmNlayoutDirection, but is kept here for backward compatibility. + + + + + + +Inherited Resources +Label inherits behavior and resources from the following +superclasses. For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +False +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +XmLabel includes translations from Primitive. +The XmLabel translations are described in the following list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +Btn2Down: + +ProcessDrag() + + + + +:KeyosfHelp: + +Help() + + + + + +The translations used by subclasses of XmLabel for menu +traversal are described in the following list. + + + +:KeyosfCancel: + +MenuEscape() + + + + +:KeyosfLeft: + +MenuTraverseLeft() + + + + +:KeyosfRight: + +MenuTraverseRight() + + + + +:KeyosfUp: + +MenuTraverseUp() + + + + +:KeyosfDown: + +MenuTraverseDown() + + + + + + + +Action Routines +The XmLabel action routines are + + + +Help(): + +In a Popup or Pulldown MenuPane, unposts all menus in the menu hierarchy +and, when the shell's keyboard focus policy is XmEXPLICIT, +restores keyboard focus to the widget that had the focus before the +menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +MenuEscape(): + +In a MenuBar, disarms the CascadeButton and the menu and, when the +shell's keyboard focus policy is XmEXPLICIT, restores keyboard +focus to the widget that had the focus before the menu was entered. + +In a top-level Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, when the shell's +keyboard focus policy is XmEXPLICIT, restores keyboard focus to +the widget that had the focus before the MenuBar was entered. +In other Pulldown MenuPanes, unposts the menu and moves the focus +to its CascadeButton. + +In a Popup MenuPane, unposts the menu and, when the shell's keyboard +focus policy is XmEXPLICIT, restores keyboard focus to the widget +from which the menu was posted. + + + + +MenuTraverseDown(): + +If the current menu item has a submenu and is in a MenuBar, then this +action posts the submenu, disarms the current menu item, and arms +the submenu's first traversable menu item. + +If the current menu item is in a MenuPane, then this action disarms the +current menu item and arms the item below it. This action wraps within the +MenuPane. The direction of the wrapping depends on the +XmNlayoutDirection resource. + + + + +MenuTraverseLeft(): + +When the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the left edge of a MenuPane, +this action disarms the current item and arms the item to its left. +If the current menu item is at the left edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the left, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the left edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +left edge, this action wraps within the MenuPane. If the current menu +item is at the left edge of the MenuPane and not in the top row, this +action wraps to the rightmost menu item in the row above. If the current +menu item is in the upper, leftmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +rightmost menu item in the MenuPane. +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the left +edge of a MenuPane, this action disarms the current item and arms the +item to its left, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the left edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the left. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the left edge of a row (except the +bottom row), this action wraps to the rightmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, leftmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, rightmost menu item of the MenuPane. + + + + +MenuTraverseRight(): + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the right. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the right +edge of a MenuPane, this action disarms the current item and arms the +item to its right, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the right edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the right. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the right edge of a row (except the +bottom row), this action wraps to the leftmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, rightmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, leftmost menu item of the MenuPane. +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. +When the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the right edge of a MenuPane, +this action disarms the current item and arms the item to its right. +If the current menu item is at the right edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the right, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the right edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +right edge, this action wraps within the MenuPane. If the current menu +item is at the right edge of the MenuPane and not in the top row, this +action wraps to the leftmost menu item in the row above. If the current +menu item is in the upper, rightmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +leftmost menu item in the MenuPane. + + + + +MenuTraverseUp(): + +When the current menu item is in a MenuPane, then +this action disarms the current menu item and arms the item above it. +This action wraps within the MenuPane. The direction of the wrapping +depends on the XmNlayoutDirection resource. + + + + +ProcessDrag(): + +Drags the contents of a Label, identified when BTransfer is +pressed. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. +This action is undefined for Labels used in a menu system. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCreateLabel;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmStringCreate;, +&cdeman.XmStringCreateLtoR;, +and &cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LabelGad.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LabelGad.sgm new file mode 100644 index 00000000..fbf9335c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LabelGad.sgm @@ -0,0 +1,1265 @@ + + + + + + + + + + + +XmLabelGadget +library call + + +XmLabelGadget +The LabelGadget widget class + +XmLabelGadget + +widget class +LabelGadget + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/LabelG.h> + + + +DESCRIPTION +LabelGadget is an instantiable widget and is also used as a superclass for +other button gadgets, such as PushButtonGadget and ToggleButtonGadget. + +LabelGadget can contain either text or a pixmap. LabelGadget text is a +compound string. +Refer to the Motif Programmer's +Guide for more information on compound strings. +The text can be multilingual, +multiline, and/or multifont. When a LabelGadget is insensitive, its text is +stippled, or the user-supplied insensitive pixmap is displayed. + +LabelGadget supports both accelerators and mnemonics primarily for use in +LabelGadget subclass widgets that are contained in +menus. Mnemonics are available in +a menu system when the button is visible. Accelerators in a +menu system are accessible even when the button is not visible. +The LabelGadget displays the mnemonic by underlining the first matching +character in the text string. The accelerator is displayed +as a text string adjacent to the label text or pixmap, depending on +the layout direction. + +LabelGadget consists of many margin fields surrounding the text or +pixmap. +These margin fields are resources that may +be set by the user, but LabelGadget subclasses and Manager parents also +modify some of these fields. They tend to modify the +XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom resources and leave the XmNmarginWidth and +XmNmarginHeight resources as set by the application. + +LabelGadget takes into account XmNshadowThickness in determining +its layout but does not draw the shadow. +That is, if XmNshadowThickness is greater than 0 (zero), LabelGadget +leaves space for the shadow, but the shadow does not appear. + +In a LabelGadget, XmNtraversalOn and XmNhighlightOnEnter are +forced to False inside Popup menu panes, Pulldown menu panes, and +OptionMenus. +Otherwise these resources default to False. + +LabelGadget uses the +XmQTmenuSystem and XmQTspecifyRenderTable traits, and +holds the XmQTaccessTextual, XmQTcareParentVisual, +XmQTmenuSavvy, and XmQTtransfer traits. + + +Data Transfer Behavior +LabelGadget and it subclasses, except when used in a menu system, +support dragging of the label contents from the LabelGadget. +However, the label contents are draggable only if +the XmNenableUnselectableDrag resource of XmDisplay +is set to True. + +As a source of data, LabelGadget and its subclasses support the +following targets and associated conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers XmNlabelString in the encoding of the locale. +This target is supported only when XmNlabelType is XmSTRING. + + + + +COMPOUND_TEXT + +The widget transfers XmNlabelString as type COMPOUND_TEXT. +This target is supported only when XmNlabelType is XmSTRING. + + + + +PIXMAP + +The widget transfers XmNlabelPixmap as type DRAWABLE. +This target is supported only when XmNlabelType is XmPIXMAP. + + + + +STRING + +The widget transfers XmNlabelString as type STRING. +This target is supported only when XmNlabelType is XmSTRING. + + + + +TEXT + +If XmNlabelString is fully convertible to the encoding of the +locale, the widget transfers XmNlabelString in the encoding of +the locale. +Otherwise, the widget transfers XmNlabelString as type +COMPOUND_TEXT. +This target is supported only when XmNlabelType is XmSTRING. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for the CLIPBOARD selection. +When XmNlabelType is XmSTRING, these include the following +targets: + + + +_MOTIF_COMPOUND_STRING + + + +COMPOUND_TEXT + + + +The encoding of the locale, if XmNlabelString is fully convertible +to the encoding of the locale + + + +STRING, if XmNlabelString is fully convertible to +STRING + + + +When XmNlabelType is XmPIXMAP, the targets include +PIXMAP. + + + + +_MOTIF_COMPOUND_STRING + +The widget transfers XmNlabelString as a compound string in Byte +Stream format. +This target is supported only when XmNlabelType is XmSTRING. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +When XmNlabelType is XmSTRING, these include +_MOTIF_COMPOUND_STRING, COMPOUND_TEXT, the encoding of the +locale, STRING, TEXT, BACKGROUND, and +FOREGROUND. +When XmNlabelType is XmPIXMAP, these include PIXMAP, +BACKGROUND, and FOREGROUND. + + + + +As a source of data, LabelGadget also supports the following standard +Motif targets: + + + +BACKGROUND + +The widget transfers the parent's XmNbackground as type +PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers the parent's XmNcolormap as type +COLORMAP. + + + + +FOREGROUND + +The widget transfers the parent's XmNforeground as type +PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +When XmNlabelType is XmSTRING, these also include +_MOTIF_COMPOUND_STRING, COMPOUND_TEXT, the encoding of the +locale, STRING, and TEXT. +When XmNlabelType is XmPIXMAP, these also include +PIXMAP. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + + + +Classes +LabelGadget inherits behavior, +resources, and traits from Object, RectObj and XmGadget. + +The class pointer is xmLabelGadgetClass. + +The class name is XmLabelGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmLabelGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +0 +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +0 +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +0 +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +0 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +dynamic +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + +XmNaccelerator + +Sets the accelerator on a button widget in a menu, which +activates a visible or invisible, but managed, button from the keyboard. +This resource is a string that describes a set of modifiers +and the key that may be used to select the button. +The format of this string +is identical to that used by the translations manager, with the exception +that only a single event may be specified and only KeyPress events are +allowed. + +Accelerators for buttons are supported only for +PushButtonGadgets and ToggleButtonGadgets in Pulldown and Popup menus. + + + + +XmNacceleratorText + +Specifies the text displayed +for the accelerator. +The text is displayed +adjacent to the label string or pixmap. The direction of its layout depends on +the XmNlayoutDirection resource of the widget. +Accelerator text for buttons is displayed only for +PushButtonGadgets and ToggleButtonGadgets in Pulldown and Popup Menus. + + + + +XmNalignment + +Specifies the label alignment for text or pixmap. + + + +XmALIGNMENT_BEGINNING (left alignment) + +Causes the left sides of +the lines of text to be vertically aligned with the +left edge of the gadget. For a pixmap, its left side is vertically +aligned with the left edge of the gadget. + + + + +XmALIGNMENT_CENTER (center alignment) + +Causes the centers of the +lines of text to be vertically aligned in the center +of the gadget. For a pixmap, its center is vertically aligned with the +center of the gadget. + + + + +XmALIGNMENT_END (right alignment) + +Causes the right sides of the +lines of text to be vertically aligned with the +right edge of the gadget. For a pixmap, its right side is +vertically aligned with the right edge of the gadget. + + + + +The preceding descriptions for text are correct when +XmNlayoutDirection is XmLEFT_TO_RIGHT. When that resource +is XmRIGHT_TO_LEFT, the descriptions for +XmALIGNMENT_BEGINNING and XmALIGNMENT_END are switched. + +If the parent is a RowColumn whose XmNisAligned resource is True, +XmNalignment is forced to the same value as the RowColumn's +XmNentryAlignment if the RowColumn's XmNrowColumnType is +XmWORK_AREA or if the gadget is a subclass of XmLabelGadget. +Otherwise, the default is XmALIGNMENT_CENTER. + + + + +XmNfontList + +Specifies the font of the text used in the gadget. XmNfontList +is obsolete and exists for compatibility with previous releases. You +should now use XmNrenderTable instead of XmNfontList. If +both are specified, the render table will take precedence. If +XmNfontList is NULL at initialization, the parent hierarchy of +the widget is searched for an ancestor that is a subclass of the +XmBulletinBoard, VendorShell, or XmMenuShell widget +class. If such an ancestor is found, the font list is initialized to +the XmNbuttonFontList (for button gadget subclasses) or +XmNlabelFontList of the ancestor widget. If no such ancestor is +found, the default is implementation dependent. Refer to +&cdeman.XmFontList; for more information on the creation and +structure of a font list. + + + + +XmNlabelInsensitivePixmap + +Specifies a pixmap used as the button face if XmNlabelType is +XmPIXMAP and the button is insensitive. +The default value, XmUNSPECIFIED_PIXMAP, displays an empty label. + + + + +XmNlabelPixmap + +Specifies the pixmap when XmNlabelType is +XmPIXMAP. +The default value, XmUNSPECIFIED_PIXMAP, displays an empty label. + + + + +XmNlabelString + +Specifies the compound string when XmNlabelType is XmSTRING. +If the value of this resource is NULL, it is initialized to name of the +gadget converted to a compound string. +Refer to &cdeman.XmString; +for more information on the +creation and the structure of compound strings. + + + + +XmNlabelType + +Specifies the label type. + + + +XmSTRING + +Text displays XmNlabelString + + + + +XmPIXMAP + +Icon data in pixmap displays XmNlabelPixmap or +XmNlabelInsensitivePixmap + + + + + + + +XmNmarginBottom + +Specifies the amount of spacing between the bottom of the label text +and the top of the bottom margin specified by XmNmarginHeight. +This may be modified by LabelGadget's subclasses. +For example, CascadeButtonGadget may increase this field to make room +for the cascade pixmap. + + + + +XmNmarginHeight + +Specifies an equal amount of spacing above the margin +defined by XmNmarginTop and below the margin defined by +XmNmarginBottom. XmNmarginHeight specifies the amount +of spacing between the top edge of the margin set by XmNmarginTop +and the bottom edge of the top shadow, and the amount of spacing between +the bottom edge of the margin specified by XmNmarginBottom and the +top edge of the bottom shadow. + + + + +XmNmarginLeft + +Specifies the amount of spacing +between the left edge of the label text and the right side of the left +margin (specified by XmNmarginWidth). +This may be modified by LabelGadget's subclasses. +For example, ToggleButtonGadget may increase this field to make room for +the toggle indicator and for spacing between the indicator and label. +Whether this actually applies to the left or right side of the label +depends on the value of +XmNlayoutDirection. + + + + +XmNmarginRight + +Specifies the amount of spacing +between the right edge of the label text and the left side of the right +margin (specified by XmNmarginWidth). +This may be modified by LabelGadget's subclasses. +For example, CascadeButtonGadget may increase this field to make room +for the cascade pixmap. +Whether this actually applies to the left or right side of the label +depends on the value of +XmNlayoutDirection. + + + + +XmNmarginTop + +Specifies the amount of spacing between the top of the label text and +the bottom of the top margin specified by XmNmarginHeight. +This may be modified by LabelGadget's subclasses. +For example, CascadeButtonGadget may increase this field to make room +for the cascade pixmap. + + + + +XmNmarginWidth + +Specifies an equal amount of spacing to the left of the margin defined +by XmNmarginLeft and to the right of the margin defined by +XmNmarginRight. XmNmarginWidth specifies the amount +of spacing between the left edge of the margin set by XmNmarginLeft +and the right edge of the left shadow, and the amount of spacing between +the right edge of the margin specified by XmNmarginRight and the +left edge of the right shadow. + + + + +XmNmnemonic + +Provides the user with an alternate means of activating a button. +A button in a MenuBar, a Popup menu pane, or a Pulldown +menu pane can have a mnemonic. + +This resource contains a keysym as listed in the X11 keysym table. +The first character in the label string that exactly matches +the mnemonic in the character set specified in +XmNmnemonicCharSet +is underlined when the button is displayed. + +When a mnemonic has been specified, the user activates the button by +pressing the mnemonic key while the button is visible. +If the button is a CascadeButtonGadget in a MenuBar and the MenuBar does +not have the focus, the user must use the MAlt modifier while +pressing the mnemonic. +The user can activate the button by pressing either the shifted or the +unshifted mnemonic key. + + + + +XmNmnemonicCharSet + +Specifies the character set of the mnemonic for the label. +The default is XmFONTLIST_DEFAULT_TAG. + + + + +XmNrecomputeSize + +Specifies a Boolean value that indicates whether the gadget +shrinks or expands to accommodate its contents (label string or +pixmap) as a result of an XtSetValues resource value that +would change the size of the gadget. If True, the gadget shrinks +or expands to exactly fit the label string or pixmap. +If False, the gadget never attempts to change size on its own. + + + + +XmNrenderTable + +Specifies the render table associated with the labelString. If +this value is NULL at initialization, Label searches its parent +hierarchy for an ancestor that holds the XmQTspecifyRenderTable trait. +If such an ancestor is +found, Label initializes XmNrenderTable to the +XmLABEL_RENDER_TABLE value of the ancestor widget. Similarly, button +subclasses of Label initialize XmNrenderTable to the +XmBUTTON_RENDER_TABLE value of the ancestor widget. (Note that all +current subclasses of Label are button subclasses.) If no such +ancestor is found, the default is implementation dependent. If a font +list and a render table are both specified, the render table will take +precedence. Refer to &cdeman.XmRenderTable; for more information on +the creation and structure of a render table. + + + + +XmNstringDirection + +Is a synthetic resource for setting XmNlayoutDirection. +The values for this resource are XmSTRING_DIRECTION_L_TO_R and +XmSTRING_DIRECTION_R_TO_L. Refer to the +XmNlayoutDirection resource description. The +XmNstringDirection resource is obsoleted by +XmNlayoutDirection, but is kept here for backward compatibility. + + + + + + +Inherited Resources +LabelGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +False +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + + + +Behavior +XmLabelGadget includes behavior from XmGadget. +Additional XmLabelGadget behavior is described in the following list: + + + +Btn2Down: + +Drags the contents of a LabelGadget, identified when BTransfer is +pressed. +This action is undefined for LabelGadgets used in a menu system. + + + + +KeyosfHelp: + +In a Popup or Pulldown MenuPane, unposts all menus in the menu hierarchy +and, when the shell's keyboard focus policy is XmEXPLICIT, +restores keyboard focus to the widget that had the focus before the +menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +keyosfCancel: + +In a MenuBar, disarms the CascadeButton and the menu and, when the +shell's keyboard focus policy is XmEXPLICIT, restores keyboard +focus to the widget that had the focus before the menu was entered. + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, when the shell's +keyboard focus policy is XmEXPLICIT, restores keyboard focus to +the widget that had the focus before the MenuBar was entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and, when the shell's keyboard +focus policy is XmEXPLICIT, restores keyboard focus to the widget +from which the menu was posted. + + + + +KeyosfDown: + +If the current menu item has a submenu and is in a MenuBar, then this +action posts the submenu, disarms the current menu item, and arms +the submenu's first traversable menu item. + +If the current menu item is in a MenuPane, then this action disarms the +current menu item and arms the item below it. This action wraps within the +MenuPane. The direction of the wrapping depends on the +XmNlayoutDirection resource. + + + + +KeyosfLeft: + +When the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the left edge of a MenuPane, +this action disarms the current item and arms the item to its left. +If the current menu item is at the left edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the left, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the left edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +left edge, this action wraps within the MenuPane. If the current menu +item is at the left edge of the MenuPane and not in the top row, this +action wraps to the rightmost menu item in the row above. If the current +menu item is in the upper, leftmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +rightmost menu item in the MenuPane. +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the left +edge of a MenuPane, this action disarms the current item and arms the +item to its left, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the left edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the left. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the left edge of a row (except the +bottom row), this action wraps to the rightmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, leftmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, rightmost menu item of the MenuPane. + + + + +KeyosfRight: + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the right. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the right +edge of a MenuPane, this action disarms the current item and arms the +item to its right, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the right edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the right. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the right edge of a row (except the +bottom row), this action wraps to the leftmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, rightmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, leftmost menu item of the MenuPane. +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. + +When the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the right. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the right edge of a MenuPane, +this action disarms the current item and arms the item to its right. +If the current menu item is at the right edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the right, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the right edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +right edge, this action wraps within the MenuPane. If the current menu +item is at the right edge of the MenuPane and not in the top row, this +action wraps to the leftmost menu item in the row above. If the current +menu item is in the upper, rightmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +leftmost menu item in the MenuPane. + + + + +KeyosfUp: + +When the current menu item is in a MenuPane, then +this action disarms the current menu item and arms the item above it. +This action wraps within the MenuPane. The direction of the wrapping +depends on the XmNlayoutDirection resource. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Object;, &cdeman.RectObj;, +&cdeman.XmCreateLabelGadget;, +&cdeman.XmFontListCreate;, +&cdeman.XmStringCreate;, +&cdeman.XmStringCreateLtoR;, +and &cdeman.XmGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/List.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/List.sgm new file mode 100644 index 00000000..b17c145f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/List.sgm @@ -0,0 +1,3115 @@ + + + + + + + + + + + +XmList +library call + + +XmList +The List widget class + +XmList + +widget class +List + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/List.h> + + + +DESCRIPTION +List allows a user to select one or more items +from a group of choices. Items are selected from the list in a +variety of ways, using both the pointer and the keyboard. +List operates on an array of compound strings that are defined by the application. +Each compound string becomes an item in the List, +with the first compound string becoming +the item in position 1, the second becoming the item in position 2, and so on. + +Specifying the number of items that are visible +sets the size of the List. +If the number of visible items is not specified, the height +of the list controls the number of visible items. Each item assumes +the height of the tallest element in the list. +To create a list that allows the user to scroll easily through a large +number of items, use the XmCreateScrolledList convenience +function. + +To select items, move the pointer or cursor to the desired item and +press the Btn1 mouse button or the key defined as +osfSelect. There are several styles of selection behavior, and +they all highlight the selected item or items by displaying them in +inverse colors. An appropriate callback is invoked to notify the +application of the user's choice. The application then takes whatever +action is required for the specified selection. +When a List is insensitive, all of the list items are displayed in a +stippled fill pattern. + +List uses the XmQTspecifyRenderTable, XmQTscrollFrame, and +XmQTnavigator traits, and +holds the XmQTtransfer trait. + + +Selection +Each list has one of four selection models: + + + +Single Select + + + +Browse Select + + + +Multiple Select + + + +Extended Select + + + +In Single Select and Browse Select, at most one item is selected at a +time. +In Single Select, pressing Btn1 on an item toggles its +selection state and deselects any other selected item. +In Browse Select, pressing Btn1 on an item selects it and +deselects any other selected item; dragging Btn1 moves the +selection as the pointer is moved. Releasing Btn1 on an +item moves the location cursor to that item. + +In Multiple Select, any number of items can be selected at a time. +Pressing Btn1 on an item toggles its selection state but +does not deselect any other selected items. + +In Extended Select, any number of items can be selected at a time, +and the user can easily select ranges of items. +Pressing Btn1 on an item selects it and deselects any other +selected item. +Dragging Btn1 or pressing or dragging ShiftBtn1 following a +Btn1 action selects all items between the item under the +pointer and the item on which Btn1 was pressed. +This action also deselects any other selected items outside that +range. + +Extended Select also allows the user to select and deselect +discontiguous ranges of items. +Pressing CtrlBtn1 on an item toggles its selection state but +does not deselect any other selected items. +Dragging CtrlBtn1 or pressing or dragging ShiftBtn1 following a +CtrlBtn1 action sets the selection state of all items between +the item under the pointer and the item on which CtrlBtn1 was +pressed to the state of the item on which CtrlBtn1 was pressed. +This action does not deselect any other selected items outside that +range. + +All selection operations available from the mouse are also available +from the keyboard. +List has two keyboard selection modes, Normal Mode and Add Mode. +In Normal Mode, navigation operations and osfSelect select the +item at the location cursor and deselect any other selected +items. +In Add Mode, navigation operations have no effect on selection, and +osfSelect toggles the selection state of the item at the location +cursor without deselecting any other selected items, except in Single +Select. + +Single and Multiple Select use Add Mode, and Browse Select uses Normal +Mode. + +Extended Select can use either mode; the user changes modes by pressing +osfAddMode. +In Extended Select Normal Mode, pressing osfSelect has the same +effect as pressing Btn1; osfExtend and shifted navigation +have the same effect as pressing ShiftBtn1 following a Btn1 +action. +In Extended Select Add Mode, pressing osfSelect has the same +effect as pressing CtrlBtn1; osfExtend and shifted navigation +have the same effect as pressing ShiftBtn1 following a CtrlBtn1 +action. + +Normal Mode is indicated by a solid location cursor, and Add Mode is +indicated by a dashed location cursor. + + + +Data Transfer Behavior +List supports dragging of items from the List and transfer of items to +the clipboard. +When the user presses BTransfer on a selected item, the widget +transfers all selected items. +When the user presses BTransfer on an unselected item, the widget +transfers only that item. +Depending on the value of XmNprimaryOwnership, List can also +support primary selection. + +When the XmNconvertCallback procedures are called, the +location_data member of the XmConvertCallbackStruct member +is NULL if the selected items are being transferred. +If the selected items are not being transferred, this member has the +following value: +If a single item is being transferred, the value is an integer +representing the position of the item in the List. +A value of 1 transfers the first item in the List; a value of 2 +transfers the second item; and so on. +If the entire contents of the List are being transferred, the value is +−1. + +As a source of data, List supports the following targets and associated +conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers the selected list items in the encoding of the locale. +Each item transferred except the last includes a trailing separator. + + + + +COMPOUND_TEXT + +The widget transfers the selected list items as type +COMPOUND_TEXT. +Each item transferred except the last includes a trailing separator. + + + + +STRING + +The widget transfers the selected list items as type STRING. +Each item transferred except the last includes a trailing separator. + + + + +TEXT + +If the selected list items are fully convertible to the encoding of the +locale, the widget transfers the selected list items in the encoding of +the locale. +Otherwise, the widget transfers the selected list items as type +COMPOUND_TEXT. +Each item transferred except the last includes a trailing separator. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for immediate transfer for the CLIPBOARD selection. +These include _MOTIF_COMPOUND_STRING. +If the selected list items are fully convertible to STRING, these +also include STRING; otherwise, they also include +COMPOUND_TEXT. + + + + +_MOTIF_COMPOUND_STRING + +The widget transfers the selected list items as a compound string in +Byte Stream format. +Each item transferred except the last includes a trailing separator. + + + + +_MOTIF_DEFERRED_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for delayed transfer for the CLIPBOARD selection. +This widget currently supplies no targets for +_MOTIF_DEFERRED_CLIPBOARD_TARGETS. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +These include _MOTIF_COMPOUND_STRING, COMPOUND_TEXT, the +encoding of the locale, STRING, TEXT, BACKGROUND, and +FOREGROUND. + + + + +_MOTIF_LOSE_SELECTION + +When the widget loses the selection, it deselects all list items. + + + + +As a source of data, List also supports the following standard Motif +targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +These also include _MOTIF_COMPOUND_STRING, COMPOUND_TEXT, +the encoding of the locale, STRING, and TEXT. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + +List has no widget class destination procedure. +Subclasses and the XmNdestinationCallback procedures are +responsible for any data transfers to the widget. + + + +Classes +List inherits behavior, resources, and traits from Core and +XmPrimitive. + +The class pointer is xmListWidgetClass. + +The class name is XmList. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, +remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmList Resource Set + + +Name +Class +Type +Default +Access + + +XmNautomaticSelection +XmCAutomaticSelection +XtEnum +False +CSG + + +XmNbrowseSelectionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdefaultActionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdestinationCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdoubleClickInterval +XmCDoubleClickInterval +int +dynamic +CSG + + +XmNextendedSelectionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNitemCount +XmCItemCount +int +0 +CSG + + +XmNitems +XmCItems +XmStringTable +NULL +CSG + + +XmNlistMarginHeight +XmCListMarginHeight +Dimension +0 +CSG + + +XmNlistMarginWidth +XmCListMarginWidth +Dimension +0 +CSG + + +XmNlistSizePolicy +XmCListSizePolicy +unsigned char +XmVARIABLE +CG + + +XmNlistSpacing +XmCListSpacing +Dimension +0 +CSG + + +XmNmatchBehavior +XmCMatchBehavior +unsigned char +XmQUICK_NAVIGATE +CSG + + +XmNmultipleSelectionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNprimaryOwnership +XmCPrimaryOwnership +unsigned char +XmOWN_NEVER +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNscrollBarDisplayPolicy +XmCScrollBarDisplayPolicy +unsigned char +XmAS_NEEDED +CSG + + +XmNselectColor +XmCSelectColor +XmRSelectColor +XmREVERSED_GROUND_COLORS +CSG + + +XmNselectedItemCount +XmCSelectedItemCount +int +0 +CSG + + +XmNselectedItems +XmCSelectedItems +XmStringTable +NULL +CSG + + +XmNselectedPositionCount +XmCSelectedPositionCount +int +0 +CSG + + +XmNselectedPositions +XmCSelectedPositions +unsigned int * +NULL +CSG + + +XmNselectionMode +XmCSelectionMode +unsigned char +dynamic +CSG + + +XmNselectionPolicy +XmCSelectionPolicy +unsigned char +XmBROWSE_SELECT +CSG + + +XmNsingleSelectionCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + +XmNtopItemPosition +XmCTopItemPosition +int +1 +CSG + + +XmNvisibleItemCount +XmCVisibleItemCount +int +dynamic +CSG + + + + + + +XmNautomaticSelection + +Invokes either +XmNbrowseSelectionCallback or XmNextendedSelectionCallback when +Btn1 is pressed and the items that are shown as selected change +if the value is True (or XmAUTO) and the selection +mode is either XmBROWSE_SELECT or XmEXTENDED_SELECT respectively. +If False (XmNO_AUTO_SELECT), no selection callbacks are invoked until +the user releases the mouse button. +See Behavior for +further details on the interaction of this resource with the selection modes. + + + + +XmNbrowseSelectionCallback + +Specifies a list of callbacks that is called +when an item is selected in the browse selection mode. The reason is +XmCR_BROWSE_SELECT. + + + + +XmNdefaultActionCallback + +Specifies a list of callbacks that is called when an item is double +clicked or osfActivate is pressed. +The reason is XmCR_DEFAULT_ACTION. + + + + +XmNdestinationCallback + +Specifies a list of callbacks called when the List is the destination of +a transfer operation. +The type of the structure whose address is passed to these callbacks is +XmDestinationCallbackStruct. +The reason is XmCR_OK. + + + + +XmNdoubleClickInterval + +If a button click is followed by another button click within the time +span specified by this resource (in milliseconds), the button clicks +are considered a double-click action, rather than two single-click +actions. +The value must not be negative. +The default value is the display's multiclick time. + + + + +XmNextendedSelectionCallback + +Specifies a list of callbacks that is called +when items are selected using the extended selection mode. +The reason is XmCR_EXTENDED_SELECT. + + + + +XmNfontList + +Specifies the font list associated with the list items. +XmNfontList is obsolete and exists only for compatibility with +previous releases. You should now use XmNrenderTable instead of +XmNfontList. If both are specified, the render table will take +precedence. The font list is used in conjunction with the +XmNvisibleItemCount +resource to determine the height of the List widget. +If this +value is NULL at initialization, the parent hierarchy of the widget is +searched for a widget that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the font list is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such widget +is found, the default is implementation dependent. Refer to +&cdeman.XmFontList; for more information on a font list structure. + + + + +XmNitemCount + +Specifies the total number of items. +The value must be the number of items in XmNitems and must not be +negative. +It is automatically updated by the list whenever an item is added to or +deleted from the list. + + + + +XmNitems + +Points to an array of compound strings that are to be displayed as the list +items. +Refer to &cdeman.XmString; for more information on the creation and +structure of compound strings. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items. + + + + +XmNlistMarginHeight + +Specifies the height of the margin between the list border and the items. + + + + +XmNlistMarginWidth + +Specifies the width of the margin between the list border and the items. + + + + +XmNlistSizePolicy + +Controls the reaction of the List when an item grows horizontally beyond +the current size of the list work area. +If the value is XmCONSTANT, the list viewing area does not grow, +and a horizontal ScrollBar is added for a List whose parent is a ScrolledWindow. +If this resource is set to XmVARIABLE, the List grows to +match the +size of the longest item, and no horizontal ScrollBar appears. + +When the value of this resource is XmRESIZE_IF_POSSIBLE, the List +attempts to grow or shrink to match the width of the widest item. +If it cannot grow to match the widest size, a horizontal ScrollBar is +added for a List whose parent is a ScrolledWindow +if the longest item is wider than the list +viewing area. + +The size policy must be set at the time the List widget is created. +It cannot be changed at a later time through XtSetValues. + + + + +XmNlistSpacing + +Specifies the spacing between list items. +This spacing increases by the value of the XmNhighlightThickness +resource in Primitive. + + + + +XmNmatchBehavior + +Specifies the matching behavior followed by XmList. +The current values are XmNONE and XmQUICK_NAVIGATE, as follows: + + + +XmNONE + +Specifies that the typed in characters are ignored. + + + + +XmQUICK_NAVIGATE + +Specifies that 1-character navigation shall be supported when List +has focus. If the typed character is +the initial character of some set of items in +List, the first of those items following the current +item will be navigated to (become the current +item). If all such items precede the current item, the +first such item becomes the current item. +Subsequently, typing the same character will +cyclically navigate among the items with the same first +character. + + + + + + + +XmNmultipleSelectionCallback + +Specifies a list of callbacks that is called +when an item is selected in +multiple selection mode. The reason is XmCR_MULTIPLE_SELECT. + + + + +XmNprimaryOwnership + +Specifies whether XmContainer takes ownership of the Primary selection +when a selection is made inside it. This resource can take the +following values: + + + +XmOWN_NEVER + +Never takes ownership. + + + + +XmOWN_ALWAYS + +Always takes ownership. + + + + +XmOWN_MULTIPLE + +Only takes ownership is more than one element has been selected. + + + + +XmOWN_POSSIBLE_MULTIPLE + +Only takes ownership if more than one element can be selected at a +time. + + + + + + + +XmNrenderTable + +Specifies the render table associated with the list items. The render +table is used in conjunction with the +XmNvisibleItemCount +resource to determine the height of the List widget. If this +value is NULL at initialization, List searches its parent hierarchy +for a widget that +holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, the render table is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such widget +is found, the default is implementation dependent. If a font list and +a render table are both specified, the +render table will take precedence. Refer to +&cdeman.XmRenderTable; for more information on the creation and +structure of a render table. + + + + +XmNscrollBarDisplayPolicy + +Controls the display of vertical ScrollBars in a +List whose parent is a ScrolledWindow. +When the value of this resource is XmAS_NEEDED, a vertical +ScrollBar is displayed only when the number of items in the List exceeds +the number of visible items. +When the value is XmSTATIC, a vertical ScrollBar is always +displayed. + + + + +XmNselectColor + +Allows the application to specify the color of the background rectangle +that indicates selected text. It takes two values: + + + +XmDEFAULT_SELECT_COLOR + +Causes the select color to be set to a color +between the background and the bottom shadow color. + + + + +XmREVERSED_GROUND_COLORS + +Forces the select color to the +foreground color and the color of any text rendered over the +select color to be in the background color. + + + + +HIGHLIGHT_COLOR + +Forces the fill color to use the highlight color. + + + + + + + +XmNselectedItemCount + +Specifies the number of strings in the selected items list. +The value must be the number of items in XmNselectedItems and must +not be negative. + + + + +XmNselectedItems + +Points to an array of compound strings that represents the list items that +are currently selected, either by the user or by the application. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items or the array. + +Setting XmNselectedItems selects those list items that exactly +match items in the given XmNselectedItems list. There may be +additional items in XmNselectedItems that do not match items in +the list. These items remain until XmNselectedItems is updated. +If XmNitems is changed such that the list now contains items +matching previously unmatched items in XmNselectedItems, those +new items will also appear selected. + +Any user interaction with the list that causes at least one item to be +selected or deselected and any call to +XmListDeleteAllItems, +XmListDeleteItem, +XmListDeleteItems, +XmListDeleteItemsPos, +XmListDeletePos, +XmListDeletePositions, +XmListDeselectAllItems, +XmListDeselectItem, XmListDeselectPos, +XmListSelectItem, XmListSelectPos, or +XmListUpdateSelectedList cause XmNselectedItems to be +updated immediately to exactly reflect the visual state of the list. +Calls to any other XmList functions do not affect +XmNselectedItems. + + + + +XmNselectedPositionCount + +Specifies the number of positions in the selected positions list. +The value must be the number of items in XmNselectedPositions + + + + +XmNselectedPositions + +Points to an array of the positions of the selected items in the List. +XtGetValues for this resource returns the +list items themselves, not a copy of the list +items. The application must not free the returned +items or the array. + + + + +XmNselectionMode + +Defines what effect keyboard navigations have on selection. The valid +modes are: + + + +XmADD_MODE + +Allows no navigation operations to have effect on selection, and +osfSelect toggles the selection state of the item at the location +cursor without deselecting any other selected items, except in Single +Select. However, the widget cannot be put into add mode if the +XmNselectionPolicy resource is an incompatible mode +(XmNselectionPolicy cannot be XmBROWSE_SELECT). + + + + +XmNORMAL_MODE + +Allows navigation operations and osfSelect to select the +item at the location cursor and deselect any other selected +items. However, the widget cannot be put into normal mode if the +XmNselectionPolicy resource is an incompatible mode +(XmNselectionPolicy cannot be XmSINGLE_SELECT or +XmMULTIPLE_SELECT). + + + + + + + +XmNselectionPolicy + +Defines the interpretation of the selection action. This can be one of the +following: + + + +XmSINGLE_SELECT + +Allows only single selections + + + + +XmMULTIPLE_SELECT + +Allows multiple selections + + + + +XmEXTENDED_SELECT + +Allows extended selections + + + + +XmBROWSE_SELECT + +Allows drag-and-browse functionality + + + + + + + +XmNsingleSelectionCallback + +Specifies a list of callbacks that is called +when an item is selected in +single selection mode. The reason is XmCR_SINGLE_SELECT. + + + + +XmNstringDirection + +Is a synthetic resource for setting XmNlayoutDirection. +The values for this resource are XmSTRING_DIRECTION_L_TO_R and +XmSTRING_DIRECTION_R_TO_L. Refer to the +XmNlayoutDirection resource description. The +XmNstringDirection resource is obsoleted by +XmNlayoutDirection, but is kept here for backward compatibility. + + + + +XmNtopItemPosition + +Specifies the position of the item that is the first visible item in the +list. +Setting this resource is equivalent to calling the XmListSetPos +function. +The position of the first item in the list is 1; the position of the +second item is 2; and so on. +A position of 0 (zero) specifies the last item in the list. +The value must not be negative. + + + + +XmNvisibleItemCount + +Specifies the number of items that can +fit in the visible space of the list work area. The List uses this +value to determine its height. +The value must be greater than 0 (zero). + + + + + + +Inherited Resources +List inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +List defines a new callback structure. The application must first look at the +reason field and use only the structure members that are valid for that +particular reason, because not all fields are relevant for +every possible reason. The callback structure is defined as follows: + +typedef struct +{ + int reason; + XEvent *event; + XmString item; + int item_length; + int item_position; + XmString *selected_items; + int selected_item_count; + int *selected_item_positions; + char selection_type; + unsigned char auto_selection_type; +} XmListCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +item + +The last item selected at the time of the event that caused the +callback. +item points to a temporary storage space that is reused after the +callback is finished. +Therefore, if an application needs to save the item, it should copy the +item into its own data space. + + + + +item_length + +The length in bytes of item. +This member is obsolete and exists for compatibility with +earlier releases. + + + + +item_position + +The position (plus one) of item in the List's XmNitems array. +An item_position value of one symbolizes the first element in the +list. + + + + +selected_items + +A list of items selected at the time of the event that caused +the callback. +selected_items points to a temporary storage space that is reused +after the callback is finished. +Therefore, if an application needs to save the selected list, it should +copy the list into its own data space. + + + + +selected_item_count + +The number of items in the selected_items list. +This number must be non-negative. + + + + +selected_item_positions + +An array of integers, one for each selected item, representing the +position of each selected item in the List's XmNitems array. +selected_item_positions points to a temporary storage space that +is reused after the callback is finished. +Therefore, if an application needs to save this array, it should copy +the array into its own data space. + + + + +selection_type + +Indicates that the most recent extended selection was the initial +selection (XmINITIAL), a modification of an existing selection +(XmMODIFICATION), or an additional noncontiguous selection +(XmADDITION). + + + + +auto_selection_type + +Indicates the type of automatic selection callback. The types of +callbacks include the following: + + + +XmAUTO_BEGIN + +Indicates the beginning of automatic selection. + + + + +XmAUTO_MOTION + +Indicates that there is a button drag selection. + + + + +XmAUTO_CANCEL + +Indicates that the new selection is cancelled. + + + + +XmAUTO_NO_CHANGE + +Indicates that the currently selected item matches the initial item. + + + + +XmAUTO_CHANGE + +Indicates that the currently selected item does not match the initial item. + + + + + + + +The following table describes the reasons for which the individual callback +structure fields are valid. + + + + + + + +Reason +Valid Fields + + +XmCR_SINGLE_SELECT +reason, event, item, item_length, item_position + + +XmCR_DEFAULT_ACTION +reason, event, item, item_length, item_position, selected_items, selected_item_count, selected_item_positions + + +XmCR_BROWSE_SELECT +reason, event, item, item_length, item_position + + +XmCR_MULTIPLE_SELECT +reason, event, item, item_length, item_position, selected_items, selected_item_count, selected_item_positions + + +XmCR_EXTENDED_SELECT +reason, event, item, item_length, item_position, selected_items, selected_item_count, selected_item_positions, selection_type + + + + +A pointer to the following callback structure is passed to the +XmNdestinationCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + XtEnum operation; + int flags; + XtPointer transfer_id; + XtPointer destination_data; + XtPointer location_data; + Time time; +} XmDestinationCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which data transfer is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, and +_MOTIF_DROP. + + + + +operation + +Indicates the type of transfer operation requested. + + + +When the selection is PRIMARY, possible values are XmMOVE, +XmCOPY, and XmLINK. + + + +When the selection is SECONDARY or CLIPBOARD, possible +values are XmCOPY and XmLINK. + + + +When the selection is _MOTIF_DROP, possible values are +XmMOVE, XmCOPY, XmLINK, and XmOTHER. +A value of XmOTHER means that the callback procedure must get +further information from the XmDropProcCallbackStruct in the +destination_data member. + + + + + + +flags + +Indicates whether or not the destination widget is also the source of +the data to be transferred. +Following are the possible values: + + + +XmCONVERTING_NONE + +The destination widget is not the source of the data to be transferred. + + + + +XmCONVERTING_SAME + +The destination widget is the source of the data to be transferred. + + + + + + + +transfer_id + +Serves as a unique ID to identify the transfer transaction. + + + + +destination_data + +Contains information about the destination. +When the selection is _MOTIF_DROP, the callback procedures are +called by the drop site's XmNdropProc, and destination_data +is a pointer to the XmDropProcCallbackStruct passed to the +XmNdropProc procedure. +When the selection is SECONDARY, destination_data is an Atom +representing a target recommmended by the selection owner for use in +converting the selection. +Otherwise, destination_data is NULL. + + + + +location_data + +Contains information about the location where data is to be transferred. +The value is always NULL when the selection is SECONDARY or +CLIPBOARD. +If the value is NULL, the data is to be inserted at the widget's cursor +position. +Otherwise, the value is an integer representing the position in the List +where the items are to be transferred. +A value of 1 makes the first new item the first item in the list; a +value of 2 makes it the second item; and so on. +Once XmTransferDone procedures start to be called, +location_data will no longer be stable. + + + + +time + +Indicates the time when the transfer operation began. + + + + + + + + + + + + + + + + +Translations +XmList includes translations from Primitive. +The XmList translations are described in the following list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +Btn1Motion: + +ListButtonMotion() + + + + +s ≈m ≈a Btn1Down: + +ListBeginExtend() + + + + +s ≈m ≈a Btn1Up: + +ListEndExtend() + + + + +c ≈s ≈m ≈a Btn1Down: + +ListBeginToggle() + + + + +c ≈s ≈m ≈a Btn1Up: + +ListEndToggle() + + + + +≈s ≈c ≈m ≈a Btn1Down: + +ListBeginSelect() + + + + +&npzwc;≈s ≈c ≈m ≈a Btn1Up: + +ListEndSelect() + + + + +Btn2Down: + +ListProcessDrag() + + + + +:s c KeyosfBeginLine: + +ListBeginDataExtend() + + + + +:c KeyosfBeginLine: + +ListBeginData() + + + + +:KeyosfBeginLine: + +ListBeginLine() + + + + +:s c KeyosfEndLine: + +ListEndDataExtend() + + + + +:c KeyosfEndLine: + +ListEndData() + + + + +:KeyosfEndLine: + +ListEndLine() + + + + +:KeyosfPageLeft: + +ListLeftPage() + + + + +:c KeyosfPageUp: + +ListLeftPage() + + + + +:KeyosfPageUp: + +ListPrevPage() + + + + +:KeyosfPageRight: + +ListRightPage() + + + + +:c KeyosfPageDown: + +ListRightPage() + + + + +:KeyosfPageDown: + +ListNextPage() + + + + +s KeyDownosfSelect: + +ListKbdBeginExtend() + + + + +:KeyDownosfSelect: + +ListKbdBeginSelect() + + + + +:s KeyUposfSelect: + +ListKbdEndExtend() + + + + +:KeyUposfSelect: + +ListKbdEndSelect() + + + + +:KeyosfSelectAll: + +ListKbdSelectAll() + + + + +:KeyosfDeselectAll: + +ListKbdDeSelectAll() + + + + +:KeyosfActivate: + +ListKbdActivate() + + + + +:KeyosfAddMode: + +ListAddMode() + + + + +:KeyosfHelp: + +PrimitiveHelp() + + + + +:KeyosfCancel: + +ListKbdCancel() + + + + +:c KeyosfLeft: + +ListLeftPage() + + + + +:KeyosfLeft: + +ListLeftChar() + + + + +:c KeyosfRight: + +ListRightPage() + + + + +:KeyosfRight: + +ListRightChar() + + + + +:s KeyosfUp: + +ListExtendPrevItem() + + + + +:KeyosfUp: + +ListPrevItem() + + + + +:s KeyosfDown: + +ListExtendNextItem() + + + + +:KeyosfDown: + +ListNextItem() + + + + +:c KeyosfInsert: + +ListCopyToClipboard() + + + + +:KeyosfCopy: + +ListCopyToClipboard() + + + + +≈s c ≈m ≈a Keyslash: + +ListKbdSelectAll() + + + + +≈s c ≈m ≈a Keybackslash: + +ListKbdDeSelectAll() + + + + +s ≈m ≈a KeyTab: + +PrimitivePrevTabGroup() + + + + +≈m ≈a KeyTab: + +PrimitiveNextTabGroup() + + + + +≈s ≈m ≈a KeyReturn: + +ListKbdActivate() + + + + +≈s ≈m ≈a KeyDownspace: + +ListKbdBeginSelect() + + + + +≈s ≈m ≈a KeyUpspace: + +ListKbdEndSelect() + + + + +s ≈m ≈a KeyDownspace: + +ListKbdBeginExtend() + + + + +s ≈m ≈a KeyUpspace: + +ListKbdEndExtend() + + + + +Key: + +ListQuickNavigate() + + + + + +The List button event translations are modified when Display's +XmNenableBtn1Transfer resource does not have a value of +XmOFF (in other words, it is either XmBUTTON2_TRANSFER or +XmBUTTON2_ADJUST). This +option allows the +actions for selection and transfer to be integrated on Btn1, and +the actions for extending the selection can be bound to +Btn2. The actions for Btn1 that are defined above +still apply when the Btn1 event occurs over text that is not +selected. The following actions apply when the Btn1 event +occurs over text that is selected: + + + +Btn1Motion: + +ListProcessBtn1(ListButtonMotion) + + + + +s ≈m ≈a Btn1Down + +ListProcessBtn1(ListBeginExtend) + + + + +s ≈m ≈a Btn1Up + +ListProcessBtn1(ListEndExtend) + + + + +c ≈s ≈m ≈a Btn1Down + +ListProcessBtn1(ListBeginToggle) + + + + +c ≈s ≈m ≈a Btn1Up + +ListProcessBtn1(ListEndToggle) + + + + +≈s ≈c ≈m ≈a Btn1Down + +ListProcessBtn1(ListBeginSelect) + + + + +≈s ≈c ≈m ≈a Btn1Up + +ListProcessBtn1(ListEndSelect) + + + + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the following actions apply: + + + +Btn2Down: + +ListProcessBtn2(ListBeginExtend) + + + + +Btn2Motion: + +ListProcessBtn2(ListButtonMotion) + + + + +Btn2Up: + +ListProcessBtn2(ListEndExtend) + + + + + + + +Action Routines +The XmList action routines are described in the following list. +The current selection is always shown with inverted colors. + + + +ListAddMode(): + +Toggles the state of Add Mode for keyboard selection. + + + + +ListBeginData(): + +Moves the location cursor to the first item in the list. +In Normal Mode, this also deselects any current selection, +selects the first item in the list, and calls the appropriate selection +callbacks (XmNbrowseSelectionCallback when +XmNselectionPolicy is set to XmBROWSE_SELECT, +XmNextendedSelectionCallback when XmNselectionPolicy is set +to XmEXTENDED_SELECT). + + + + +ListBeginDataExtend(): + +If XmNselectionPolicy is set to XmMULTIPLE_SELECT or +XmEXTENDED_SELECT, +this action moves the location cursor to the first item in the list. + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done; +changes the selection state of the first item and all +items between it and the current anchor point to the state of the +item at the current anchor point; +calls the XmNextendedSelectionCallback callbacks. + + + + +ListBeginExtend(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done, and +changes the selection state of the item under the pointer and all +items between it and the current anchor point to the state of the +item at the current anchor point. +If XmNautomaticSelection is set to True, this action calls the +XmNextendedSelectionCallback callbacks. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN. + + + + +ListBeginLine(): + +Moves the horizontal scroll region to the beginning of the line. + + + + +ListBeginSelect(): + +If XmNselectionPolicy is set to XmSINGLE_SELECT, +deselects any current selection and toggles the selection state of the +item under the pointer. + +If XmNselectionPolicy is set to XmBROWSE_SELECT, +deselects any current selection and selects the item under the pointer. +If XmNautomaticSelection is set to True, calls the +XmNbrowseSelectionCallback callbacks. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN. + +If XmNselectionPolicy is set to XmMULTIPLE_SELECT, +toggles the selection state of the item under the pointer. +Any previous selections remain. + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action deselects any current selection, +selects the item under the pointer, and +sets the current anchor at that item. +If XmNautomaticSelection is set to True, +this action calls the +XmNextendedSelectionCallback callbacks. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN. + + + + +ListBeginToggle(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action moves the current anchor to the item under the pointer +without changing the current selection. +If the item is unselected, this action selects it; if the item is selected, +this action unselects it. +If XmNautomaticSelection is set to True, this action calls the +XmNextendedSelectionCallback callbacks. + +Otherwise, the list takes keyboard focus. No other action occurs. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN. + + + + +ListButtonMotion(): + +If XmNselectionPolicy is set to XmBROWSE_SELECT, +this action deselects any current selection and selects the item under the +pointer. +If XmNautomaticSelection is set to True and the pointer has +entered a new list item, this action calls the XmNbrowseSelectionCallback +callbacks. + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action does the following: +If an extended selection is being made and an extended selection has +previously been made from the current anchor point, +restores the selection state of the items in that range to their state +before the previous extended selection was done and +changes the selection state of the item under the pointer and all +items +between it and the current anchor point to the state of the +item at the current anchor point. +If XmNautomaticSelection is set to True and the pointer has +entered a new list item, calls the XmNextendedSelectionCallback +callbacks. + +If the pointer leaves a scrolled list, this action scrolls the list in +the direction of the pointer motion. +The auto_selection_type component of the callback structure will +be set to XmAUTO_MOTION. + + + + +ListCopyToClipboard() + +Copies the content of the selected items to the clipboard as a single +compound string with each +item separated by a newline. +This action calls the XmNconvertCallback procedures, possibly +multiple times, for the CLIPBOARD selection. + + + + +ListEndData(): + +Moves the location cursor to the last item in the list. +In Normal Mode, this also deselects any current selection, +selects the last item in the list, and calls the appropriate selection +callbacks (XmNbrowseSelectionCallback when +XmNselectionPolicy is set to XmBROWSE_SELECT, +XmNextendedSelectionCallback when XmNselectionPolicy is set +to XmEXTENDED_SELECT). + + + + +ListEndDataExtend(): + +If XmNselectionPolicy is set to XmMULTIPLE_SELECT or +XmEXTENDED_SELECT, +this action moves the location cursor to the last item in the list. + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done; +changes the selection state of the last item and all +items between it and the current anchor point to the state of the +item at the current anchor point; +calls the XmNextendedSelectionCallback callbacks. + + + + +ListEndExtend(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action moves the location +cursor to the last item selected or deselected +and +calls the +XmNextendedSelectionCallback callbacks. + +If XmNautomaticSelection is set to True, then the +auto_selection_type field of the callback will be +valid. If XmNselectionPolicy is set to XmBROWSE_SELECT +and the currently selected item position matches the position of the +item that was selected before the browse selection began, or if +XmNselectionPolicy is set to XmEXTENDED_SELECT and the set +of currently selected item positions matches the set of item positions +selected before the extended selection began, the callback will be +called with auto_selection_type set to XmAUTO_NO_CHANGE. +Otherwise, it will be set to XmAUTO_CHANGE. + + + + +ListEndLine(): + +Moves the horizontal scroll region to the end of the line. + + + + +ListEndSelect(): + +This action moves the location cursor to the last item selected or +deselected and calls the appropriate selection callbacks +(XmNsingleSelectionCallback when XmNselectionPolicy is set +to XmSINGLE_SELECT, XmNbrowseSelectionCallback when +XmNselectionPolicy is set to XmBROWSE_SELECT, +XmNmultipleSelectionCallback when +XmNselectionPolicy is set to XmMULTIPLE_SELECT, +XmNextendedSelectionCallback when XmNselectionPolicy is +set to XmEXTENDED_SELECT). + +If XmNautomaticSelection is set to True, then the +auto_selection_type field of the callback will be valid. +If XmNselectionPolicy is set to XmBROWSE_SELECT and the +currently selected item position matches the position of the item that +was selected before the brose selection began, or if +XmNselectionPolicy is set to XmEXTENDED_SELECT and the set +of currently selected item positions matches the set of item positions +selected before the extended selection began, the callback will be +called with auto_selection_type set to XmAUTO_NO_CHANGE. +Otherwise, it will be set to XmAUTO_CHANGE. + + + + +ListEndToggle(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, moves +the location cursor to the last item selected or deselected +and +calls the +XmNextendedSelectionCallback callbacks. + +If XmNautomaticSelection is set to True, then the +auto_selection_type field of the callback will be valid. If +XmNselectionPolicy is set to XmBROWSE_SELECT and the +currently selected item position matches the position of the item that +was selected before the browse selection began, or if +XmNselectionPolicy is set to XmEXTENDED_SELECT and the set +of currently selected item positions matches the set of item positions +selected before the extended selection began, the callback will be +called with auto_selection_type set to XmAUTO_NO_CHANGE. +Otherwise, it will be set to XmAUTO_CHANGE. + + + + +ListExtendNextItem(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action +does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done; +moves the location cursor to the next item and changes the selection +state of the item and all +items between it and the current anchor point +to the state of the item at the current anchor point; +calls the XmNextendedSelectionCallback callbacks. + + + + +ListExtendPrevItem(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done; +moves the location cursor to the previous item and changes the selection +state of the item and all items between it and the current anchor point +to the state of the item at the current anchor point; +calls the XmNextendedSelectionCallback callbacks. + + + + +ListScrollCursorVertically(percentage): + +Scrolls the line containing the insertion cursor vertically +to an intermediate position in the visible window based on an +input percentage. A value of 0 (zero) indicates the top of the window; +a value of 100, the bottom of the window. If this action is called +with no argument, the line containing the insertion cursor is scrolled +vertically to a new position designated by the y event passed +to the routine. + + + + +ListKbdActivate(): + +Calls the callbacks for XmNdefaultActionCallback. +If the List's parent is a manager, this action passes the event to the +parent. + + + + +ListKbdBeginExtend(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +does the following: +If an extended selection has been made from the current anchor point, +restores the selection state of the items in that range to their state +before the extended selection was done; +changes the selection state of the item at the location cursor and all +items between it and the current anchor point to the state of the +item at the current anchor point. +If XmNautomaticSelection is set to True, this action calls the +XmNextendedSelectionCallback callbacks. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN". + + + + +ListKbdBeginSelect(): + +If the XmNselectionPolicy is set to XmSINGLE_SELECT, +deselects any current selection and toggles the state of the item at the +location cursor. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN". + +If the XmNselectionPolicy is set to XmBROWSE_SELECT, +deselects any current selection and selects the item at the location +cursor. +If XmNautomaticSelection is set to True, calls the +XmNbrowseSelectionCallback callbacks. + +If the XmNselectionPolicy is set to XmMULTIPLE_SELECT, +toggles the selection state of the item at the location cursor. +Any previous selections remain. + +If the XmNselectionPolicy is set to XmEXTENDED_SELECT, +moves the current anchor to the item at the location cursor. +In Normal Mode, this action +deselects any current selection and selects the item at +the location cursor. +In Add Mode, this action +toggles the selection state of the item at the location +cursor and leaves the current selection unchanged. +If XmNautomaticSelection is set to True, this action +calls the XmNextendedSelectionCallback callbacks. +The auto_selection_type component of the callback structure will +be set to XmAUTO_BEGIN". + + + + +ListKbdCancel(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT +and an extended selection is being made from the current anchor point, +this action +cancels the new selection and restores the selection state of the items +in that range to their state before the extended selection was done. +If XmNautomaticSelection is set to True, this action calls the +XmNextendedSelectionCallback callbacks; otherwise, if the +parent is a manager, it passes the event to the parent. +The auto_selection_type component of the callback structure will +be set to XmAUTO_CANCEL". + + + + +ListKbdDeSelectAll(): + +If the XmNselectionPolicy is set to XmSINGLE_SELECT, +XmMULTIPLE_SELECT, or XmEXTENDED_SELECT in Add Mode, +this action deselects all items in the list. +If the XmNselectionPolicy is set to XmEXTENDED_SELECT in +Normal Mode, this action deselects all items in the list (except the item at the +location cursor if the shell's XmNkeyboardFocusPolicy is +XmEXPLICIT). +This action also calls the appropriate selection callbacks +(XmNsingleSelectionCallback when XmNselectionPolicy is set +to XmSINGLE_SELECT, XmNmultipleSelectionCallback when +XmNselectionPolicy is set to XmMULTIPLE_SELECT, +XmNextendedSelectionCallback when XmNselectionPolicy is set +to XmEXTENDED_SELECT). + + + + +ListKbdEndExtend(): + +If XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action calls the +XmNextendedSelectionCallback callbacks. + +If XmNautomaticSelection is set to True, then the +auto_selection_type field of the callback will be valid. If +XmNselectionPolicy is set to XmBROWSE_SELECT and the +currently selected item position matches the position of the item that +was selected before the browse selection began, or if +XmNselectionPolicy is set to XmEXTENDED_SELECT and the set +of currently selected item positions matches the set of item positions +selected before the extended selection began, the callback will be +called with auto_selection_type set to XmAUTO_NO_CHANGE. +Otherwise, it will be set to XmAUTO_CHANGE. + + + + +ListKbdEndSelect(): + +Calls the appropriate selection callbacks +(XmNsingleSelectionCallback when XmNselectionPolicy is set +to XmSINGLE_SELECT, XmNbrowseSelectionCallback when +XmNselectionPolicy is set to XmBROWSE_SELECT, +XmNmultipleSelectionCallback when XmNselectionPolicy is set +to XmMULTIPLE_SELECT, XmNextendedSelectionCallback when +XmNselectionPolicy is set to XmEXTENDED_SELECT). + +If XmNautomaticSelection is set to True, then the +auto_selection_type field of the callback will be valid. If +XmNselectionPolicy is set to XmBROWSE_SELECT and the +currently selected item position matches the position of the item that +was selected before the browse selection began, or if +XmNselectionPolicy is set to XmEXTENDED_SELECT and the set +of currently selected item positions matches the set of item positions +selected before the extended selection began, the callback will be +called with auto_selection_type set to XmAUTO_NO_CHANGE. +Otherwise, it will be set to XmAUTO_CHANGE. + + + + +ListKbdSelectAll(): + +If XmNselectionPolicy is set to XmSINGLE_SELECT or +XmBROWSE_SELECT, this action selects the item at the location cursor. +If XmNselectionPolicy is set to XmEXTENDED_SELECT or +XmMULTIPLE_SELECT, +it selects all items in the list. +This action also calls the appropriate selection callbacks +(XmNsingleSelectionCallback when XmNselectionPolicy is set +to XmSINGLE_SELECT, XmNbrowseSelectionCallback when +XmNselectionPolicy is set to XmBROWSE_SELECT, +XmNmultipleSelectionCallback when XmNselectionPolicy is set +to XmMULTIPLE_SELECT, XmNextendedSelectionCallback when +XmNselectionPolicy is set to XmEXTENDED_SELECT). + + + + +ListLeftChar(): + +Scrolls the list one character to the left. + + + + +ListLeftPage(): + +Scrolls the list one page to the left. + + + + +ListNextItem(): + +Moves the location cursor to the next item in the list. + +If the XmNselectionPolicy is set to XmBROWSE_SELECT, +this action also selects the next item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. + +If the XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action in Normal Mode also selects the next item, deselects any +current selection, moves the current anchor to the next item, and calls +the XmNextendedSelectionCallback callbacks. +In Add Mode, this action does not affect the selection or the anchor. + + + + +ListNextPage(): + +Scrolls the list to the next page, moving the location cursor to a new +item. + +If the XmNselectionPolicy is set to XmBROWSE_SELECT, +this action also selects the new item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. + +If the XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action in Normal Mode also selects the new item, deselects any +current selection, moves the current anchor to the new item, and calls +the XmNextendedSelectionCallback callbacks. +In Add Mode, this action does not affect the selection or the anchor. + + + + +ListPrevItem(): + +Moves the location cursor to the previous item in the list. + +If the XmNselectionPolicy is set to XmBROWSE_SELECT, +this action also selects the previous item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. + +If the XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action in Normal Mode also selects the previous item, deselects any +current selection, moves the current anchor to the previous item, and +calls the XmNextendedSelectionCallback callbacks. +In Add Mode, this action does not affect the selection or the anchor. + + + + +ListPrevPage(): + +Scrolls the list to the previous page, moving the location cursor to a +new item. + +If the XmNselectionPolicy is set to XmBROWSE_SELECT, +this action also selects the new item, deselects any current +selection, and calls the XmNbrowseSelectionCallback callbacks. + +If the XmNselectionPolicy is set to XmEXTENDED_SELECT, +this action in Normal Mode also selects the new item, deselects any +current selection, moves the current anchor to the new item, and calls +the XmNextendedSelectionCallback callbacks. +In Add Mode this action does not affect the selection or the anchor. + + + + +ListProcessBtn1(string) + +When Display's XmNenableBtn1Transfer resource is not XmOFF, +the +actions for selection and transfer are integrated on Btn1. +When the button is not performing a transfer or drag, the action that is +performed depends on the value of string, which can be one of +the following actions: + + + +ListButtonMotion + + + +ListBeginExtend + + + +ListEndExtend + + + +ListBeginToggle + + + +ListEndToggle + + + +ListBeginSelect + + + +ListEndSelect + + + + + + +ListProcessBtn2 + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_TRANSFER, the +actions for extending selection are bound on Btn2, and a drag +starts immediately. +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the action that is +performed depends on the value of string, which can be one of +the following actions: + + + +ListBeginExtend + + + +ListButtonMotion + + + +ListEndExtend + + + + + + +ListProcessDrag(): + +Drags the content of one or more selected list items. +Each item is separated by a newline. +If BTransfer is pressed on an unselected item, it drags only that +item, excluding any other selected items. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. + + + + +ListQuickNavigate + +Navigates to an item. When List's +XmNmatchBehavior resource is XmQUICK_NAVIGATE, this +action uses 1-character +navigation to navigate. Refer to the XmNmatchBehavior resource +for a description of how this navigation works. + + + + +ListRightChar(): + +Scrolls the list one character to the right. + + + + +ListRightPage(): + +Scrolls the list one page to the right. + + + + +PrimitiveHelp(): + +Calls the callbacks for XmNhelpCallback if any exist. If there +are no help callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +PrimitiveNextTabGroup(): + +Moves the focus to the first item contained within the next tab group. If +the current tab group is the last entry in the tab group list, it +wraps to the beginning of the tab group list. + + + + +PrimitivePrevTabGroup(): + +Moves the focus to the first item contained within the previous tab group. +If the beginning of the tab group list is reached, it wraps to the end +of the tab group list. + + + + + + +Additional Behavior +The List widget has the following additional behavior: + + + +Double Click + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, the List interprets +that as a double click and calls the callbacks for +XmNdefaultActionCallback. +The item's colors invert to indicate that it is selected. +The XmNdoubleClickInterval resource can be used to specify a +time span that overrides the display's multi-click time. + + + + +FocusIn: + +If the focus policy is Explicit, this action sets the focus and draw +the location cursor. + + + + +FocusOut: + +If the focus policy is Explicit, this action removes the focus and erase +the location cursor. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCreateList;, +&cdeman.XmCreateScrolledList;, +&cdeman.XmFontListCreate;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmListAddItem;, +&cdeman.XmListAddItems;, +&cdeman.XmListAddItemUnselected;, +&cdeman.XmListAddItemsUnselected;, +&cdeman.XmListDeleteAllItems;, +&cdeman.XmListDeleteItem;, +&cdeman.XmListDeleteItems;, +&cdeman.XmListDeleteItemsPos;, +&cdeman.XmListDeletePos;, +&cdeman.XmListDeletePositions;, +&cdeman.XmListDeselectAllItems;, +&cdeman.XmListDeselectItem;, +&cdeman.XmListDeselectPos;, +XmListGetKbdItemPos &cdeman.XmListGetMatchPos;, +&cdeman.XmListGetSelectedPos;, +&cdeman.XmListItemExists;, +&cdeman.XmListItemPos;, +&cdeman.XmListPosToBounds;, +&cdeman.XmListReplaceItems;, +&cdeman.XmListReplaceItemsPos;, +&cdeman.XmListReplaceItemsPos;, +&cdeman.XmListReplaceItemsPosUnselected;, +&cdeman.XmListReplaceItemsUnselected;, +&cdeman.XmListSelectItem;, +&cdeman.XmListSelectPos;, +&cdeman.XmListSetAddMode;, +&cdeman.XmListSetBottomItem;, +&cdeman.XmListSetBottomPos;, +&cdeman.XmListSetHorizPos;, +&cdeman.XmListSetItem;, +&cdeman.XmListSetKbdItemPos;, +&cdeman.XmListSetPos;, +&cdeman.XmListUpdateSelectedList;, +&cdeman.XmListYToPos;, +&cdeman.XmPrimitive; and +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIA.sgm new file mode 100644 index 00000000..1f5177b5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIA.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + +XmListAddItem +library call + + +XmListAddItem +A List function that adds an item to the list + +XmListAddItem + +List functions +XmListAddItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListAddItem + +Widget widget +XmString item +int position + + + +DESCRIPTION +XmListAddItem adds an item to the list at the given position. +When the item is inserted into the list, it is compared with the current +XmNselectedItems list. +If the new item matches an item on the selected list, it appears +selected. + + + +widget + +Specifies the ID of the List to which an item is added. + + + + +item + +Specifies the item to be added to the list. + + + + +position + +Specifies the position of the new item in the list. +A value of 1 makes the new item the first item in the list; a value of 2 +makes it the second item; and so on. +A value of 0 (zero) makes the new item the last item in the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIB.sgm new file mode 100644 index 00000000..00651add --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIB.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmListAddItemUnselected +library call + + +XmListAddItemUnselected +A List function that adds an item to the list + +XmListAddItemUnselected + +List functions +XmListAddItemUnselected + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListAddItemUnselected + +Widget widget +XmString item +int position + + + +DESCRIPTION +XmListAddItemUnselected adds an item to the list at the given +position. +The item does not appear selected, even if it matches an item in the +current XmNselectedItems list. + + + +widget + +Specifies the ID of the List from whose list an item is added. + + + + +item + +Specifies the item to be added to the list. + + + + +position + +Specifies the position of the new item in the list. +A value of 1 makes the new item the first item in the list; a value of 2 +makes it the second item; and so on. +A value of 0 (zero) makes the new item the last item in the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIC.sgm new file mode 100644 index 00000000..525f8059 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddIC.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmListAddItems +library call + + +XmListAddItems +A List function that adds items to the list + +XmListAddItems + +List functions +XmListAddItems + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListAddItems + +Widget widget +XmString *items +int item_count +int position + + + +DESCRIPTION +XmListAddItems adds the specified items to the list at the given +position. +The first item_count items of the items array are added to +the list. +When the items are inserted into the list, they are compared with the +current XmNselectedItems list. +If any of the new items matches an item on the selected list, it +appears selected. + + + +widget + +Specifies the ID of the List to which an item is added. + + + + +items + +Specifies a pointer to the items to be added to the list. + + + + +item_count + +Specifies the number of items in items. +This number must be nonnegative. + + + + +position + +Specifies the position of the first new item in the list. +A value of 1 makes the first new item the first item in the list; a +value of 2 makes it the second item; and so on. +A value of 0 (zero) makes the first new item follow the last item in the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddID.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddID.sgm new file mode 100644 index 00000000..fbe9d582 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstAddID.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmListAddItemsUnselected +library call + + +XmListAddItemsUnselected +A List function that adds items +to a list + +XmListAddItemsUnselected + +List functions +XmListAddItemsUnselected + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListAddItemsUnselected + +Widget widget +XmString *items +int item_count +int position + + + +DESCRIPTION +XmListAddItemsUnselected adds the specified items to the +list at the given position. The inserted items remain unselected, +even if they currently appear in the XmNselectedItems +list. + + + +widget + +Specifies the ID of the List widget to add items to. + + + + +items + +Specifies a pointer to the items to be added to the +list. + + + + +item_count + +Specifies the number of elements in items. +This number must be nonnegative. + + + + +position + +Specifies the position of the first new item in the list. A value +of 1 makes the first new item the first item in the list; a value +of 2 makes it the second item; and so on. A value of 0 (zero) +makes the +first new item follow the last item of the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleA.sgm new file mode 100644 index 00000000..533a1e0d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleA.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + + +XmListDeleteAllItems +library call + + +XmListDeleteAllItems +A List function that deletes all items from the list + +XmListDeleteAllItems + +List functions +XmListDeleteAllItems + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeleteAllItems + +Widget widget + + + +DESCRIPTION +XmListDeleteAllItems deletes all items from the list. + + + +widget + +Specifies the ID of the List from whose list the items are deleted + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleB.sgm new file mode 100644 index 00000000..28a810e1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleB.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmListDeleteItem +library call + + +XmListDeleteItem +A List function that deletes an item from the list + +XmListDeleteItem + +List functions +XmListDeleteItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeleteItem + +Widget widget +XmString item + + + +DESCRIPTION +XmListDeleteItem deletes the first item in the list that matches +item. +A warning message appears if the item does not exist. + + + +widget + +Specifies the ID of the List from whose list an item is deleted. + + + + +item + +Specifies the text of the item to be deleted from the list. +If item appears more than once in the List, only the +first occurrence is matched. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleC.sgm new file mode 100644 index 00000000..3a02cb85 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleC.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmListDeleteItems +library call + + +XmListDeleteItems +A List function that deletes items from the list + +XmListDeleteItems + +List functions +XmListDeleteItems + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeleteItems + +Widget widget +XmString *items +int item_count + + + +DESCRIPTION +XmListDeleteItems deletes the specified items from the list. +For each element of items, the first item in the list that matches +that element is deleted. +A warning message appears if any of the items do not exist. + + + +widget + +Specifies the ID of the List from whose list an item is deleted + + + + +items + +Specifies a pointer to items to be deleted from the list + + + + +item_count + +Specifies the number of elements in items +This number must be nonnegative. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleD.sgm new file mode 100644 index 00000000..db10fccf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleD.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmListDeleteItemsPos +library call + + +XmListDeleteItemsPos +A List function that deletes items from the list starting at the given position + +XmListDeleteItemsPos + +List functions +XmListDeleteItemsPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeleteItemsPos + +Widget widget +int item_count +int position + + + +DESCRIPTION +XmListDeleteItemsPos deletes the specified number of items from +the list starting at the specified position. + + + +widget + +Specifies the ID of the List from whose list an item is deleted. + + + + +item_count + +Specifies the number of items to be deleted. +This number must be nonnegative. + + + + +position + +Specifies the position in the list of the first item to be deleted. +A value of 1 indicates that the first deleted item is the first item in +the list; a value of 2 indicates that it is the second item; and so on. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleE.sgm new file mode 100644 index 00000000..379d1882 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleE.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmListDeletePos +library call + + +XmListDeletePos +A List function that deletes an item from a list at a specified position + +XmListDeletePos + +List functions +XmListDeletePos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeletePos + +Widget widget +int position + + + +DESCRIPTION +XmListDeletePos deletes an item at a specified position. +A warning message appears if the position does not exist. + + + +widget + +Specifies the ID of the List from which an item is to be deleted. + + + + +position + +Specifies the position of the item to be deleted. +A value of 1 indicates that the first item in the list is deleted; a +value of 2 indicates that the second item is deleted; and so on. +A value of 0 (zero) +indicates that the last item in the list is deleted. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleF.sgm new file mode 100644 index 00000000..d473f700 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeleF.sgm @@ -0,0 +1,98 @@ + + + + + + + + + + + +XmListDeletePositions +library call + + +XmListDeletePositions +A List function that deletes items +from a list based on an array of positions + +XmListDeletePositions + +List functions +XmListDeletePositions + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeletePositions + +Widget widget +int *position_list +int position_count + + + +DESCRIPTION +XmListDeletePositions deletes noncontiguous +items from a list. The function deletes all items whose +corresponding positions appear in the position_list array. +A warning message is displayed if a specified position is invalid; +that is, the value is 0, a negative integer, or a number greater +than the number of items in the list. + + + +widget + +Specifies the ID of the List widget + + + + +position_list + +Specifies an array of the item positions to be deleted. The +position of the first item in the list is 1; the position of +the second item is 2; and so on. + + + + +position_count + +Specifies the number of elements in the position_list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseA.sgm new file mode 100644 index 00000000..c806cbb1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseA.sgm @@ -0,0 +1,76 @@ + + + + + + + + + + + +XmListDeselectAllItems +library call + + +XmListDeselectAllItems +A List function that unhighlights and removes all items from the selected list + +XmListDeselectAllItems + +List functions +XmListDeselectAllItems + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeselectAllItems + +Widget widget + + + +DESCRIPTION +XmListDeselectAllItems unhighlights and removes all items from the +selected list. + + + +widget + +Specifies the ID of the List widget from whose list all selected +items are deselected + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseB.sgm new file mode 100644 index 00000000..6bd2eed7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseB.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + + +XmListDeselectItem +library call + + +XmListDeselectItem +A List function that deselects the specified item from the selected list + +XmListDeselectItem + +List functions +XmListDeselectItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeselectItem + +Widget widget +XmString item + + + +DESCRIPTION +XmListDeselectItem unhighlights and removes from the selected list +the first item in the list that matches item. + + + +widget + +Specifies the ID of the List from whose list an item is deselected. + + + + +item + +Specifies the item to be deselected from the list. +If item appears more than once in the List, only the +first occurrence is matched. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseC.sgm new file mode 100644 index 00000000..cec911a5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstDeseC.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmListDeselectPos +library call + + +XmListDeselectPos +A List function that deselects an item at a specified position in the list + +XmListDeselectPos + +List functions +XmListDeselectPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListDeselectPos + +Widget widget +int position + + + +DESCRIPTION +XmListDeselectPos unhighlights the item at the specified position +and deletes it from the list of selected items. + + + +widget + +Specifies the ID of the List widget + + + + +position + +Specifies the position of the item to be deselected. +A value of 1 indicates that the first item in the list is deselected; a +value of 2 indicates that the second item is deselected; and so on. +A value of 0 (zero) indicates that the last item in the list is deselected. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetKb.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetKb.sgm new file mode 100644 index 00000000..b460e463 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetKb.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmListGetKbdItemPos +library call + + +XmListGetKbdItemPos +A List function that returns the +position of the item at the location cursor + +XmListGetKbdItemPos + +List functions +XmListGetKbdItemPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +int XmListGetKbdItemPos + +Widget widget + + + +DESCRIPTION +XmListGetKbdItemPos returns the position of the list +item at the location cursor. + + + +widget + +Specifies the ID of the List widget + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns the position of the current keyboard item. A value of 1 +indicates that the location cursor is at the first item of the +list; a value of 2 indicates that it is at the second item; and +so on. A value of 0 (zero) indicates the List widget is empty. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetMa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetMa.sgm new file mode 100644 index 00000000..1d3322d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetMa.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmListGetMatchPos +library call + + +XmListGetMatchPos +A List function that returns all instances of an item in the list + +XmListGetMatchPos + +List functions +XmListGetMatchPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListGetMatchPos + +Widget widget +XmString item +int **position_list +int *position_count + + + +DESCRIPTION +XmListGetMatchPos is a Boolean function that returns an array of +positions where a specified item is found in a List. + + + +widget + +Specifies the ID of the List widget. + + + + +item + +Specifies the item to search for. + + + + +position_list + +Returns an array of positions at which the item occurs in the List. +The position of the first item in the list is 1; the position of the +second item is 2; and so on. +When the return value is True, XmListGetMatchPos allocates +memory for this array. +The caller is responsible for freeing this memory. +The caller can recover the allocated memory by calling XtFree. + + + + +position_count + +Returns the number of elements in the position_list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns True if the specified item is present in the list, and +False if it is not. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetSe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetSe.sgm new file mode 100644 index 00000000..77f957e2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstGetSe.sgm @@ -0,0 +1,106 @@ + + + + + + + + + + + +XmListGetSelectedPos +library call + + +XmListGetSelectedPos +A List function that returns the position of every selected item in the list + +XmListGetSelectedPos + +List functions +XmListGetSelectedPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListGetSelectedPos + +Widget widget +int **position_list +int *position_count + + + +DESCRIPTION +This routine is obsolete. It is +replaced by calling XtGetValues for the List resources +XmNselectedPositions and XmNselectedPositionCount. +XmListGetSelectedPos is a Boolean function that returns an +array of the positions of the selected items in a List. + + + +widget + +Specifies the ID of the List widget. + + + + +position_list + +Returns an array of the positions of the selected items in the List. +The position of the first item in the list is 1; the position of the +second item is 2; and so on. +When the return value is True, XmListGetSelectedPos allocates +memory for this array. +The caller is responsible for freeing this memory. +The caller can recover the allocated memory by calling XtFree. + + + + +position_count + +Returns the number of elements in the position_list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns True if the list has any selected items, and False if it does +not. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemE.sgm new file mode 100644 index 00000000..6e46b4d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemE.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmListItemExists +library call + + +XmListItemExists +A List function that checks if a specified item is in the list + +XmListItemExists + +List functions +XmListItemExists + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListItemExists + +Widget widget +XmString item + + + +DESCRIPTION +XmListItemExists is a Boolean function that checks if a specified +item is present in the list. + + + +widget + +Specifies the ID of the List widget + + + + +item + +Specifies the item whose presence is checked + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns True if the specified item is present in the list. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemP.sgm new file mode 100644 index 00000000..30885f0f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstItemP.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmListItemPos +library call + + +XmListItemPos +A List function that returns the position of an item in the list + +XmListItemPos + +List functions +XmListItemPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +int XmListItemPos + +Widget widget +XmString item + + + +DESCRIPTION +XmListItemPos returns the position of the first +instance of the specified item in a list. + + + +widget + +Specifies the ID of the List widget + + + + +item + +Specifies the item whose position is returned + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns the position in the list of the first instance of the specified +item. +The position of the first item in the list is 1; the position of the +second item is 2; and so on. +This function returns 0 (zero) if the item is not found. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosSe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosSe.sgm new file mode 100644 index 00000000..7990bc4f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosSe.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmListPosSelected +library call + + +XmListPosSelected +A List function that determines if the +list item at a specified position is selected + +XmListPosSelected + +List functions +XmListPosSelected + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListPosSelected + +Widget widget +int position + + + +DESCRIPTION +XmPosSelected determines if the list item at the specified +position is selected or not. + + + +widget + +Specifies the ID of the List widget + + + + +position + +Specifies the position of the list item. A value of 1 indicates +the first item in the list; a value of 2 indicates the second item; +and so on. A value of 0 (zero) specifies the last item in the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns True if the list item is selected; otherwise, returns False +if the item is not selected or the specified position is invalid. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosTo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosTo.sgm new file mode 100644 index 00000000..7732d92a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstPosTo.sgm @@ -0,0 +1,134 @@ + + + + + + + + + + + +XmListPosToBounds +library call + + +XmListPosToBounds +A List function that returns the bounding +box of an item at a specified position in a list + +XmListPosToBounds + +List functions +XmListPosToBounds + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListPosToBounds + +Widget widget +int position +Position *x +Position *y +Dimension *width +Dimension *height + + + +DESCRIPTION +XmListPosToBounds returns the coordinates +of an item within a list and the dimensions of its bounding +box. The function returns the associated x and y-coordinates +of the upper left corner of the bounding box relative to the +upper left corner of the List widget, as well as the width +and the height of the box. The caller can pass a NULL value +for the x, y, width, or height parameters +to indicate that the return value for that parameter is not +requested. + + + +widget + +Specifies the ID of the List widget. + + + + +position + +Specifies the position of the specified item. +A value of 1 indicates the first item in +the list; a value of 2 indicates the second item; and so on. A +value of 0 (zero) specifies the last item in the list. + + + + +x + +Specifies a pointer to the returned x-coordinate of the item. + + + + +y + +Specifies the pointer to the returned y-coordinate of the item. + + + + +width + +Specifies the pointer to the returned width of the item. + + + + +height + +Specifies the pointer to the returned height of the item. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +If the item at the specified position is not visible, +returns False, and the returned values (if any) are undefined. Otherwise, +this function returns True. + + + +RELATED +&cdeman.XmList; and +&cdeman.XmListYToPos;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplA.sgm new file mode 100644 index 00000000..11370dfe --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplA.sgm @@ -0,0 +1,110 @@ + + + + + + + + + + + +XmListReplaceItems +library call + + +XmListReplaceItems +A List function that replaces the specified elements in the list + +XmListReplaceItems + +List functions +XmListReplaceItems + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListReplaceItems + +Widget widget +XmString *old_items +int item_count +XmString *new_items + + + +DESCRIPTION +XmListReplaceItems replaces each specified item of the list +with a corresponding new item. +When the items are inserted into the list, they are compared with +the current XmNselectedItems list. If any of the new items +matches an item on the selected list, it appears selected. + + + +widget + +Specifies the ID of the List widget. + + + + +old_items + +Specifies the items to be replaced. + + + + +item_count + +Specifies the number of items in old_items and new_items. +This number must be nonnegative. + + + + +new_items + +Specifies the replacement items. + + + + +Every occurrence of each element of old_items is replaced with +the corresponding element from new_items. +That is, the first element of old_items is replaced with the first +element of new_items. The second element of old_items is replaced +with the second element of new_items, and so on until item_count +is reached. + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplB.sgm new file mode 100644 index 00000000..b959d283 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplB.sgm @@ -0,0 +1,115 @@ + + + + + + + + + + + +XmListReplaceItemsPos +library call + + +XmListReplaceItemsPos +A List function that replaces the specified elements in the list + +XmListReplaceItemsPos + +List functions +XmListReplaceItemsPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListReplaceItemsPos + +Widget widget +XmString *new_items +int item_count +int position + + + +DESCRIPTION +XmListReplaceItemsPos replaces the specified number of +items of the List with new items, starting at the specified position +in the List. +When the items are inserted into the list, they are compared with +the current XmNselectedItems list. If any of the new items +matches an item on the selected list, it appears selected. + + + +widget + +Specifies the ID of the List widget. + + + + +new_items + +Specifies the replacement items. + + + + +item_count + +Specifies the number of items in new_items and the number of +items in the list to replace. +This number must be nonnegative. + + + + +position + +Specifies the position of the first item in the list to be replaced. +A value of 1 indicates that the first item replaced is the first item in +the list; a value of 2 indicates that it is the second item; and so on. + +Beginning with the item specified in position, item_count +items in the list are replaced with the corresponding elements from +new_items. +That is, the item at position is replaced with the first element +of new_items; the item after position is replaced with the +second element of new_items; and so on, until item_count is +reached. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplC.sgm new file mode 100644 index 00000000..fd1971f2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplC.sgm @@ -0,0 +1,116 @@ + + + + + + + + + + + +XmListReplaceItemsPosUnselected +library call + + +XmListReplaceItemsPosUnselected +A List function that replaces items +in a list without selecting the replacement items + +XmListReplaceItemsPosUn\\%selected + +List functions +XmListReplaceItemsPosUn\\%selected + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListReplaceItemsPosUnselected + +Widget widget +XmString *new_items +int item_count +int position + + + +DESCRIPTION +XmListReplaceItemsPosUnselected replaces the specified number of +items in the list with new items, starting at the given position. The +replacement items remain unselected, even if they currently appear in +the XmNselectedItems list. + + + +widget + +Specifies the ID of the List widget to replace items in. + + + + +new_items + +Specifies a pointer to the replacement items. + + + + +item_count + +Specifies the number of elements in new_items and the +number of items in the list to replace. +This number must be nonnegative. + + + + +position + +Specifies the position of the first item in the list to +be replaced. A value of 1 indicates that the first item +replaced is the first item in the list; a value of 2 +indicates that it is the second item; and so on. + +Beginning with the item specified in position, +item_count items in the list are replaced with +the corresponding elements from new_items. That +is, the item at position is replaced with the +first element of new_items; the item after +position is replaced with the second element +of new_items; and so on, until item_count +is reached. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplD.sgm new file mode 100644 index 00000000..8b1dc2c8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplD.sgm @@ -0,0 +1,113 @@ + + + + + + + + + + + +XmListReplaceItemsUnselected +library call + + +XmListReplaceItemsUnselected +A List function that replaces items +in a list + +XmListReplaceItemsUn\\%selected + +List functions +XmListReplaceItemsUn\\%selected + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListReplaceItemsUnselected + +Widget widget +XmString *old_items +int item_count +XmString *new_items + + + +DESCRIPTION +XmListReplaceItemsUnselected replaces each specified item in the +list with a corresponding new item. The replacement items +remain unselected, even if they currently appear in the XmNselectedItems +list. + + + +widget + +Specifies the ID of the List widget to replace items in. + + + + +old_items + +Specifies a pointer to the list items to be replaced. + + + + +item_count + +Specifies the number of elements in old_items and +new_items. +This number must be nonnegative. + + + + +new_items + +Specifies a pointer to the replacement items. Every +occurrence of each element of old_items is replaced +with the corresponding element from new_items. That +is, the first element of old_items is replaced with +the first element of new_items. The second element +of old_items is replaced with the second element of +new_items, and so on until item_count is +reached. If an element in old_items does not exist +in the list, the corresponding entry in new_items +is skipped. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplE.sgm new file mode 100644 index 00000000..d059c414 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstReplE.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmListReplacePositions +library call + + +XmListReplacePositions +A List function that replaces items +in a list based on position + +XmListReplacePositions + +List functions +XmListReplacePositions + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListReplacePositions + +Widget widget +int *position_list +XmString *item_list +int item_count; + + + +DESCRIPTION +XmListReplacePositions replaces noncontiguous items +in a list. The item at each position specified in position_list +is replaced with the corresponding entry in item_list. +When the items are inserted into the list, they are compared with the +current XmNselectedItems list. Any of the new items that match +items on the selected list appear selected. A warning message +is displayed if a specified position is invalid; that is, the value is 0 (zero), +a negative integer, or a number greater than the number of items +in the list. + + + +widget + +Specifies the ID of the List widget. + + + + +position_list + +Specifies an array of the positions of items to be replaced. The +position of the first item in the list is 1; the position of the +second item is 2; and so on. + + + + +item_list + +Specifies an array of the replacement items. + + + + +item_count + +Specifies the number of elements in position_list and +item_list. +This number must be nonnegative. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleA.sgm new file mode 100644 index 00000000..9e1f178e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleA.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmListSelectItem +library call + + +XmListSelectItem +A List function that selects an item in the list + +XmListSelectItem + +List functions +XmListSelectItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSelectItem + +Widget widget +XmString item +Boolean notify + + + +DESCRIPTION +XmListSelectItem highlights and adds to the selected list the +first item in the list that matches item. + + + +widget + +Specifies the ID of the List widget from whose list an item is selected. + + + + +item + +Specifies the item to be selected in the List widget. +If item appears more than once in the List, only the +first occurrence is matched. + + + + +notify + +Specifies a Boolean value that when TRUE invokes the selection callback +for the current mode. From an application interface view, calling this +function with notify True is indistinguishable from a user-initiated +selection action. +When notify is FALSE, no callbacks are called. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList; and +&cdeman.XmListSelectPos;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleB.sgm new file mode 100644 index 00000000..94d9a878 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSeleB.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmListSelectPos +library call + + +XmListSelectPos +A List function that selects an item at a specified position in the list + +XmListSelectPos + +List functions +XmListSelectPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSelectPos + +Widget widget +int position +Boolean notify + + + +DESCRIPTION +XmListSelectPos highlights a List item at the specified position +and adds it to the list of selected items. + + + +widget + +Specifies the ID of the List widget. + + + + +position + +Specifies the position of the item to be selected. +A value of 1 indicates that the first item in the list is selected; a +value of 2 indicates that the second item is selected; and so on. +A value of 0 (zero) indicates that the last item in the list is selected. + + + + +notify + +Specifies a Boolean value that when TRUE invokes the selection callback +for the current mode. From an application interface view, calling this +function with notify True is indistinguishable from a user-initiated +selection action. +When notify is FALSE, no callbacks are called. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList; and +&cdeman.XmListSelectItem;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetAd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetAd.sgm new file mode 100644 index 00000000..bf739127 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetAd.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmListSetAddMode +library call + + +XmListSetAddMode +A List function that sets add mode in the list + +XmListSetAddMode + +List functions +XmListSetAddMode + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetAddMode + +Widget widget +Boolean state + + + +DESCRIPTION +XmListSetAddMode allows applications +control over Add Mode in the extended selection model. +This function ensures that the mode it sets is compatible with the +selection policy (XmNselectionPolicy) of the widget. For +example, it cannot put the widget into add mode when the value of +XmNselectionPolicy is XmBROWSE_SELECT. + + + +widget + +Specifies the ID of the List widget + + + + +state + +Specifies whether to activate or deactivate Add Mode. +If state +is True, Add Mode is activated. If state is +False, Add Mode is deactivated. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBA.sgm new file mode 100644 index 00000000..e10caec6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBA.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmListSetBottomItem +library call + + +XmListSetBottomItem +A List function that makes an existing item the last visible item in the list + +XmListSetBottomItem + +List functions +XmListSetBottomItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetBottomItem + +Widget widget +XmString item + + + +DESCRIPTION +XmListSetBottomItem makes the first item in the list that matches +item the last visible item in the list. + + + +widget + +Specifies the ID of the List widget from whose list an item is made the +last visible + + + + +item + +Specifies the item + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBB.sgm new file mode 100644 index 00000000..21a82ef5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetBB.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmListSetBottomPos +library call + + +XmListSetBottomPos +A List function that makes a specified item the last visible item in the list + +XmListSetBottomPos + +List functions +XmListSetBottomPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetBottomPos + +Widget widget +int position + + + +DESCRIPTION +XmListSetBottomPos makes the item at the specified position the +last visible item in the List. + + + +widget + +Specifies the ID of the List widget. + + + + +position + +Specifies the position of the item to be made the last visible item in +the list. +A value of 1 indicates that the first item in the list is the last +visible item; a value of 2 indicates that the second item is the last +visible item; and so on. +A value of 0 (zero) indicates that the last item in the list is the last +visible item. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetHo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetHo.sgm new file mode 100644 index 00000000..a7f96f07 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetHo.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmListSetHorizPos +library call + + +XmListSetHorizPos +A List function that scrolls to the specified position in the list + +XmListSetHorizPos + +List functions +XmListSetHorizPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetHorizPos + +Widget widget +int position + + + +DESCRIPTION +XmListSetHorizPos sets the XmNvalue resource of the +horizontal ScrollBar to the +specified position and updates the visible portion of the list with the +new value if the List widget's XmNlistSizePolicy is set to +XmCONSTANT or XmRESIZE_IF_POSSIBLE +and the horizontal ScrollBar is currently visible. +This is equivalent to moving the horizontal ScrollBar to the specified +position. + + + +widget + +Specifies the ID of the List widget + + + + +position + +Specifies the horizontal position + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetIt.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetIt.sgm new file mode 100644 index 00000000..3cacdeb3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetIt.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmListSetItem +library call + + +XmListSetItem +A List function that makes an existing item the first visible item in the list + +XmListSetItem + +List functions +XmListSetItem + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetItem + +Widget widget +XmString item + + + +DESCRIPTION +XmListSetItem makes the first item in the list that matches +item the first visible item in the list. + + + +widget + +Specifies the ID of the List widget from whose list an item is made the +first visible + + + + +item + +Specifies the item + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetKb.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetKb.sgm new file mode 100644 index 00000000..027a627f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetKb.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmListSetKbdItemPos +library call + + +XmListSetKbdItemPos +A List function that sets the +location cursor at a specified position + +XmListSetKbdItemPos + +List functions +XmListSetKbdItemPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +Boolean XmListSetKbdItemPos + +Widget widget +int position + + + +DESCRIPTION +XmListSetKbdItemPos sets the location cursor at the +item specified by position. This function does not +determine if the item at the specified position is +selected or not. + + + +widget + +Specifies the ID of the List widget. + + + + +position + +Specifies the position of the item at which the location +cursor is set. A value of 1 indicates the first item in +the list; a value of 2 indicates the second item; and so +on. A value of 0 (zero) sets the location cursor at the last item +in the list. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns False if no item exists at the specified position or if +the list is empty; otherwise, returns True. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetPo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetPo.sgm new file mode 100644 index 00000000..4abf6c2c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstSetPo.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmListSetPos +library call + + +XmListSetPos +A List function that makes the item at the given position the first visible position in the list + +XmListSetPos + +List functions +XmListSetPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListSetPos + +Widget widget +int position + + + +DESCRIPTION +XmListSetPos makes the item at the given position the first +visible position in the list. + + + +widget + +Specifies the ID of the List widget. + + + + +position + +Specifies the position of the item to be made the first visible item in +the list. +A value of 1 indicates that the first item in the list is the first +visible item; a value of 2 indicates that the second item is the first +visible item; and so on. +A value of 0 (zero) indicates that the last item in the list is the first +visible item. + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstUpdat.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstUpdat.sgm new file mode 100644 index 00000000..6527604a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstUpdat.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmListUpdateSelectedList +library call + + +XmListUpdateSelectedList +A List function that updates +the XmNselectedItems resource + +XmListUpdateSelectedList + +List functions +XmListUpdateSelectedList + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +void XmListUpdateSelectedList + +Widget widget + + + +DESCRIPTION +XmListUpdateSelectedList frees the contents of the +current XmNselectedItems list. The routine traverses +the XmNitems list and adds each currently selected item to +the XmNselectedItems list. For each selected item, there is +a corresponding entry in the updated XmNselectedItems list. + + + +widget + +Specifies the ID of the List widget to update + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RELATED +&cdeman.XmList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstYToPo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstYToPo.sgm new file mode 100644 index 00000000..a99cfb29 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/LstYToPo.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmListYToPos +library call + + +XmListYToPos +A List function that returns the position of the item at a specified y-coordinate + +XmListYToPos + +List functions +XmListYToPos + + + + + + + + + + + + + + + + + + + + + +#include <Xm/List.h> + +int XmListYToPos + +Widget widget +Position y + + + +DESCRIPTION +XmListYToPos returns the position of the item +at the given y-coordinate within the list. + + + +widget + +Specifies the ID of the List widget + + + + +y + +Specifies the y-coordinate in the list's coordinate system + + + + +For a complete definition of List and its associated resources, see +&cdeman.XmList;. + + + +RETURN +Returns the position of the item at the specified y +coordinate. A value of 1 indicates the first item in the +list; a value of 2 indicates the second item; and so on. A +value of 0 (zero) indicates that no item exists at the specified +y coordinate. + + + +RELATED +&cdeman.XmList; and &cdeman.XmListPosToBounds;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinA.sgm new file mode 100644 index 00000000..0314070a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinA.sgm @@ -0,0 +1,806 @@ + + + + + + + + + + + +XmMainWindow +library call + + +XmMainWindow +The MainWindow widget class + +XmMainWindow + +widget class +MainWindow + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/MainW.h> + + + +DESCRIPTION +MainWindow provides a standard layout for the primary window of an +application. This layout includes a MenuBar, a CommandWindow, a work +region, a MessageWindow, and ScrollBars. Any or all of these areas are optional. The +work region and ScrollBars in the MainWindow behave identically to the work +region and ScrollBars in the ScrolledWindow widget. The user can think of +the MainWindow as an extended ScrolledWindow with an optional MenuBar and +optional CommandWindow and MessageWindow. + +In a fully loaded MainWindow, the MenuBar spans the top of the window +horizontally. The CommandWindow spans the MainWindow horizontally just below +the MenuBar, and the work region lies below the CommandWindow. +The MessageWindow is below the work region. +Any space remaining below the +MessageWindow is managed in a manner identical to ScrolledWindow. +The behavior of ScrolledWindow can be controlled by the ScrolledWindow +resources. +To create a MainWindow, first create the +work region elements, a MenuBar, a CommandWindow, a MessageWindow, a +horizontal +ScrollBar, and a vertical ScrollBar widget, and then +call XmMainWindowSetAreas with those widget IDs. + +MainWindow +can also create three Separator widgets that provide a visual separation of +MainWindow's four components. +The user can specify resources in a resource file for the automatically +created gadgets that contain the MainWindow separators. The name of the +first separator gadget is Separator1; the second is Separator2; +and the third is Separator3. + +MainWindow also provides the following three child types for layout at +creation time: + + + +XmMENU_BAR + + + +XmCOMMAND_WINDOW + + + +XmMESSAGE_WINDOW + + + +MainWindow can use these child types +at creation time instead of their associated resource values. +MainWindow uses the XmQTmenuSystem trait. + + +Descendants +MainWindow automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +HorScrollBar +XmScrollBar +horizontal scroll bar + + +Separator1 +XmSeparatorGadget +optional first separator + + +Separator2 +XmSeparatorGadget +optional second separator + + +Separator3 +XmSeparatorGadget +optional third separator + + +VertScrollBar +XmScrollBar +vertical scroll bar + + + + + + +Classes +MainWindow inherits behavior and resources from Core, +Composite, Constraint, XmManager, +and +XmScrolledWindow. + +The class pointer is xmMainWindowWidgetClass. + +The class name is XmMainWindow. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove +the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmMainWindow Resource Set + + +Name +Class +Type +Default +Access + + +XmNcommandWindow +XmCCommandWindow +Widget +NULL +CSG + + +XmNcommandWindowLocation +XmCCommandWindowLocation +unsigned char +ABOVE (SeeDesc.) +CG + + +XmNmainWindowMarginHeight +XmCMainWindowMarginHeight +Dimension +0 +CSG + + +XmNmainWindowMarginWidth +XmCMainWindowMarginWidth +Dimension +0 +CSG + + +XmNmenuBar +XmCMenuBar +Widget +NULL +CSG + + +XmNmessageWindow +XmCMessageWindow +Widget +NULL +CSG + + +XmNshowSeparator +XmCShowSeparator +Boolean +False +CSG + + + + + + + +XmNcommandWindow + +Specifies the widget to be laid out as the CommandWindow. This widget +must have been previously created and managed as a child of MainWindow. + + + + +XmNcommandWindowLocation + +Controls the position of the command window. XmCOMMAND_ABOVE_WORKSPACE +locates the command window between the menu bar and the work window. +XmCOMMAND_BELOW_WORKSPACE locates the command window between the +work window and the message window. + + + + +XmNmainWindowMarginHeight + +Specifies the margin height on the top and bottom of MainWindow. This +resource overrides any setting of the +ScrolledWindow resource +XmNscrolledWindowMarginHeight. + + + + +XmNmainWindowMarginWidth + +Specifies the margin width on the right and left sides of MainWindow. This +resource overrides any setting of the ScrolledWindow resource +XmNscrolledWindowMarginWidth. + + + + +XmNmenuBar + +Specifies the widget to be laid out as the MenuBar. This widget must +have been previously created and managed as a child of MainWindow. + + + + +XmNmessageWindow + +Specifies the widget to be laid out as the MessageWindow. This widget +must have been previously created and managed as a child of MainWindow. +The MessageWindow is positioned at the bottom of the MainWindow. +If this value is NULL, no message window is included in the MainWindow. + + + + +XmNshowSeparator + +Displays separators between the components of the MainWindow when set +to True. If set to False, no separators are displayed. + + + + + + +Inherited Resources +MainWindow inherits behavior and resources from the +superclasses described in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmScrolledWindow Resource Set + + +Name +Class +Type +Default +Access + + +XmNautoDragModel +XmCAutoDragModel +XtEnum +XmAUTO_DRAG_ENABLED +CSG + + +XmNclipWindow +XmCClipWindow +Widget +dynamic +G + + +XmNhorizontalScrollBar +XmCHorizontalScrollBar +Widget +dynamic +CSG + + +XmNscrollBarDisplayPolicy +XmCScrollBarDisplayPolicy +unsigned char +dynamic +CSG + + +XmNscrollBarPlacement +XmCScrollBarPlacement +unsigned char +XmBOTTOM_RIGHT +CSG + + +XmNscrolledWindowMarginHeight +XmCScrolledWindowMarginHeight +Dimension +0 +N/A + + +XmNscrolledWindowMarginWidth +XmCScrolledWindowMarginWidth +Dimension +0 +N/A + + +XmNscrollingPolicy +XmCScrollingPolicy +unsigned char +XmAPPLICATION_DEFINED +CG + + +XmNspacing +XmCSpacing +Dimension +4 +CSG + + +XmNtraverseObscuredCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNverticalScrollBar +XmCVerticalScrollBar +Widget +dynamic +CSG + + +XmNvisualPolicy +XmCVisualPolicy +unsigned char +dynamic +G + + +XmNworkWindow +XmCWorkWindow +Widget +NULL +CSG + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +MainWindow inherits translations from ScrolledWindow. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, +&cdeman.XmCreateMainWindow;, +&cdeman.XmMainWindowSep1;, &cdeman.XmMainWindowSep2;, +&cdeman.XmMainWindowSep3;, +&cdeman.XmMainWindowSetAreas;, +&cdeman.XmManager;, and &cdeman.XmScrolledWindow; + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinB.sgm new file mode 100644 index 00000000..2f0dc281 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinB.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmMainWindowSep1 +library call + + +XmMainWindowSep1 +A MainWindow function that returns the widget ID of the first Separator + +XmMainWindowSep1 + +MainWindow functions +XmMainWindowSep1 + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MainW.h> + +Widget XmMainWindowSep1 + +Widget widget + + + +DESCRIPTION +XmMainWindowSep1 returns the widget ID of the first Separator +in the MainWindow. +The first Separator is located between the MenuBar and the Command widget. +This Separator is visible only when XmNshowSeparator is True. + +NOTE: XmMainWindowSep1 is obsolete and exists for compatibility +with previous releases. Use XtNameToWidget instead. Pass +a MainWindow variable as the first argument to XtNameToWidget +and pass Separator1 as the second argument. + + + +widget + +Specifies the MainWindow widget ID + + + + +For a complete definition of MainWindow and its associated resources, see +&cdeman.XmMainWindow;. + + + +RETURN +Returns the widget ID of the first Separator. + + + +RELATED +&cdeman.XmMainWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinC.sgm new file mode 100644 index 00000000..748b9e34 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinC.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmMainWindowSep2 +library call + + +XmMainWindowSep2 +A MainWindow function that returns the widget ID of the second Separator widget + +XmMainWindowSep2 + +MainWindow functions +XmMainWindowSep2 + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MainW.h> + +Widget XmMainWindowSep2 + +Widget widget + + + +DESCRIPTION +XmMainWindowSep2 returns the widget ID of the second Separator in the +MainWindow. The second Separator is located between the +Command widget and the ScrolledWindow. +This Separator is visible only when XmNshowSeparator is True. + +NOTE: XmMainWindowSep2 is obsolete and exists for compatibility +with previous releases. Use XtNameToWidget instead. Pass +a MainWindow variable as the first argument to XtNameToWidget +and pass Separator2 as the second argument. + + + +widget + +Specifies the MainWindow widget ID + + + + +For a complete definition of MainWindow and its associated resources, see +&cdeman.XmMainWindow;. + + + +RETURN +Returns the widget ID of the second Separator. + + + +RELATED +&cdeman.XmMainWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinD.sgm new file mode 100644 index 00000000..f4bd747a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinD.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmMainWindowSep3 +library call + + +XmMainWindowSep3 +A MainWindow function that returns the widget ID of the third Separator widget + +XmMainWindowSep3 + +MainWindow functions +XmMainWindowSep3 + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MainW.h> + +Widget XmMainWindowSep3 + +Widget widget + + + +DESCRIPTION +XmMainWindowSep3 returns the widget ID of the third Separator in the +MainWindow. The third Separator is located between the +message window and the widget above it. +This Separator is visible only when XmNshowSeparator is True. + +NOTE: XmMainWindowSep3 is obsolete and exists for compatibility +with previous releases. Use XtNameToWidget instead. Pass +a MainWindow variable as the first argument to XtNameToWidget +and pass Separator3 as the second argument. + + + +widget + +Specifies the MainWindow widget ID + + + + +For a complete definition of MainWindow and its associated resources, see +&cdeman.XmMainWindow;. + + + +RETURN +Returns the widget ID of the third Separator. + + + +RELATED +&cdeman.XmMainWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinE.sgm new file mode 100644 index 00000000..df97a54a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MainWinE.sgm @@ -0,0 +1,148 @@ + + + + + + + + + + + +XmMainWindowSetAreas +library call + + +XmMainWindowSetAreas +A MainWindow function that identifies manageable children for each area + +XmMainWindowSetAreas + +MainWindow functions +XmMainWindowSetAreas + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MainW.h> + +void XmMainWindowSetAreas + +Widget widget +Widget menu_bar +Widget command_window +Widget horizontal_scrollbar +Widget vertical_scrollbar +Widget work_region + + + +DESCRIPTION +XmMainWindowSetAreas identifies which of the valid children for each +area (such as the MenuBar and work region) are to be actively managed by MainWindow. +This function also sets up or adds the MenuBar, work window, command +window, and ScrollBar widgets to the application's main window widget. + +Each area is optional; therefore, the user can pass NULL to one or more +of the following arguments. The window manager provides the title bar. + +NOTE: XmMainWindowSetAreas is obsolete and exists for +compatibility with previous releases. +The information previously returned by this function can now be +obtained through a call to XtGetValues on the +XmNscrolledWindowChildType resource. + + + +widget + +Specifies the MainWindow widget ID. + + + + +menu_bar + +Specifies the widget ID for the MenuBar to be associated +with the MainWindow widget. Set this ID only after creating an instance +of the MainWindow widget. The attribute name associated with this +argument is XmNmenuBar. + + + + +command_window + +Specifies the widget ID for the command window +to be associated +with the MainWindow widget. Set this ID only after creating an instance +of the MainWindow widget. The attribute name associated with this +argument is XmNcommandWindow. + + + + +horizontal_scrollbar + +Specifies the ScrollBar widget ID for the +horizontal ScrollBar to be associated +with the MainWindow widget. Set this ID only after creating an instance +of the MainWindow widget. The attribute name associated with this +argument is XmNhorizontalScrollBar. + + + + +vertical_scrollbar + +Specifies the ScrollBar widget ID for the +vertical ScrollBar to be associated +with the MainWindow widget. Set this ID only after creating an instance +of the MainWindow widget. The attribute name associated with this +argument is XmNverticalScrollBar. + + + + +work_region + +Specifies the widget ID for the work window to be associated +with the MainWindow widget. Set this ID only after creating an instance +of the MainWindow widget. The attribute name associated with this +argument is XmNworkWindow. + + + + +For a complete definition of MainWindow and its associated resources, see +&cdeman.XmMainWindow;. + + + +RELATED +&cdeman.XmMainWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Manager.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Manager.sgm new file mode 100644 index 00000000..8010c62e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Manager.sgm @@ -0,0 +1,1485 @@ + + + + + + + + + + + +XmManager +library call + + +XmManager +The Manager widget class + +XmManager + +widget class +Manager + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +Manager is a widget class used as a supporting superclass for other +widget classes. It supports the +visual resources, graphics contexts, and traversal resources necessary for the +graphics and traversal mechanisms. + + +Classes +Manager inherits behavior and resources from Core, +Composite, and Constraint. + +The class pointer is xmManagerWidgetClass. + +The class name is XmManager. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + +XmNbottomShadowColor + +Specifies the color to use to draw the bottom +and right sides of the border shadow. +This color is used if the XmNbottomShadowPixmap resource is NULL. + + + + +XmNbottomShadowPixmap + +Specifies the pixmap to use to draw the bottom and right sides of the border +shadow. + + + + +XmNforeground + +Specifies the foreground drawing color used by manager widgets. + + + + +XmNhelpCallback + +Specifies the list of callbacks that are called when the help key +sequence is pressed. The reason sent by this callback is XmCR_HELP. + + + + +XmNhighlightColor + +Specifies the color of the highlighting rectangle. +This color is used if the highlight pixmap resource is +XmUNSPECIFIED_PIXMAP. + + + + +XmNhighlightPixmap + +Specifies the pixmap used to draw the highlighting rectangle. + + + + +XmNinitialFocus + +Specifies the ID of a widget descendant of the manager. +The widget must meet these conditions: + + + +The widget must be either a tab group or a non-tab-group widget that can +receive keyboard focus. +For the definition of a tab group, see the description of the Manager, +Primitive, and Gadget XmNnavigationType resources. +In general a widget can receive keyboard focus when it is a primitive, a +gadget, or a manager (such as a DrawingArea with no traversable +children) that acts as a primitive. + + + +The widget must not be a descendant of a tab group that is itself a +descendant of the manager. +That is, the widget cannot be contained within a tab group that is +nested inside the manager. + + + +The widget and its ancestors must have a value of True for their +XmNtraversalOn resources. + + + +If the widget does not meet these conditions, XmNinitialFocus is +treated as if the value were NULL. + +This resource is meaningful only when the nearest shell ancestor's +XmNkeyboardFocusPolicy is XmEXPLICIT. +It is used to determine which widget receives focus in these situations: + + + +When the manager is the child of a shell and the shell hierarchy +receives focus for the first time + + + +When focus is inside the shell hierarchy, the manager is a composite tab +group, and the user traverses to the manager via the keyboard + + + +Focus is then determined as follows: + + + +If XmNinitialFocus is a traversable non-tab-group widget, that +widget receives focus. + + + +If XmNinitialFocus is a traversable tab group, that tab group +receives focus. +If that tab group is a composite with descendant tab groups or +traversable non-tab-group widgets, these procedures are used recursively +to assign focus to a descendant of that tab group. + + + +If XmNinitialFocus is NULL, the first traversable non-tab-group +widget that is not contained within a nested tab group receives focus. + + + +If XmNinitialFocus is NULL and no traversable non-tab-group widget +exists, the first traversable tab group that is not contained within a +nested tab group receives focus. +If that tab group is a composite with descendant tab groups or +traversable non-tab-group widgets, these procedures are used recursively +to assign focus to a descendant of that tab group. + + + +If a shell hierarchy regains focus after losing it, focus returns to the +widget that had the focus at the time it left the hierarchy. + +The use of XmNinitialFocus is undefined if the manager is a +MenuBar, PulldownMenu, PopupMenu, or OptionMenu. + + + + +XmNlayoutDirection + +Specifies the direction in which components of the manager (including +strings) are laid out. The values are of type XmDirection. If +the widget's parent is a manager or shell, the value is inherited from +the widget's parent. Otherwise, it is inherited from the closest +ancestor vendor or menu shell. Refer to the &cdeman.XmDirection; +reference page for the possible direction values. + + + + +XmNnavigationType + +Determines whether the widget is a tab group. + + + +XmNONE + +Indicates that the widget is not a tab group. + + + + +XmTAB_GROUP + +Indicates that the widget is a tab group, unless +the XmNnavigationType of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmSTICKY_TAB_GROUP + +Indicates that the widget is a tab group, even if +the XmNnavigationType of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmEXCLUSIVE_TAB_GROUP + +Indicates that the widget is a tab group and +that widgets in the hierarchy whose XmNnavigationType is +XmTAB_GROUP are not tab groups. + +When a parent widget has an XmNnavigationType of +XmEXCLUSIVE_TAB_GROUP, traversal of non-tab-group widgets within +the group is based on the order of those widgets in their parent's +XmNchildren list. + +When the XmNnavigationType of any widget in a hierarchy is +XmEXCLUSIVE_TAB_GROUP, traversal of tab groups in the hierarchy +proceeds to widgets in the order in which their XmNnavigationType +resources were specified as XmEXCLUSIVE_TAB_GROUP or +XmSTICKY_TAB_GROUP, whether by creating the widgets with that value, +by calling XtSetValues, or by calling XmAddTabGroup. + + + + + + + + +XmNpopupHandlerCallback + +Allows the application to control which popup menu will be +automatically posted. The reason can either be XmCR_POST or +XmCR_REPOST: + + +XmCR_POST + +Indicates that this is a regular posting request. + + + + +XmCR_REPOST + +Indicates that the menu was just unposted and that this callback was +invoked on a replay. + + + + +This callback +uses the XmPopupHandlerCallbackStruct +structure to pass information. + + + + +XmNshadowThickness + +Specifies the thickness of the drawn border shadow. +XmBulletinBoard and its descendants set this value dynamically. +If the widget is a top-level window, this value is set to 1. +If it is not a top-level window, this value is set to 0 (zero). + + + + +XmNstringDirection + +Is a synthetic resource for setting XmNlayoutDirection. +The values for this resource are XmSTRING_DIRECTION_L_TO_R and +XmSTRING_DIRECTION_R_TO_L. Refer to the +XmNlayoutDirection resource description. The +XmNstringDirection resource is obsoleted by +XmNlayoutDirection, but is kept here for backward compatibility. + + + + +XmNtopShadowColor + +Specifies the color to use to draw the top and +left sides of the border shadow. +This color is used if the XmNtopShadowPixmap resource is NULL. + + + + +XmNtopShadowPixmap + +Specifies the pixmap to use to draw the top and left sides of +the border shadow. + + + + +XmNtraversalOn + +Specifies whether traversal is activated for this widget. + + + + +XmNunitType + +Provides the basic support for resolution independence. +It defines the type of units a widget uses with sizing and +positioning resources. +If the widget's parent is a subclass of XmManager and if the +XmNunitType resource is not explicitly set, it defaults to the +unit type of the parent widget. +If the widget's parent is not a subclass of XmManager, the +resource has a default unit type of XmPIXELS. + +The unit type can also be specified in resource files, with the +following format: + + +<floating value><unit> + + +where: + + + +unit + +is <" ", pixels, inches, centimeters, millimeters, points, font units> + + + + +pixels + +is <pix, pixel, pixels> + + + + +inches + +is <in, inch, inches> + + + + +centimeter + +is <cm, centimeter, centimeters> + + + + +millimeters + +is <mm, millimeter, millimeters> + + + + +points + +is <pt, point, points> + + + + +font units + +is <fu, font_unit, font_units> + + + + +float + +is {"+"|"-"}{{<"0"-"9">*}.}<"0"-"9">* + +Note that the type Dimension must always be positive. + + + + +For example, + + +xmfonts*XmMainWindow.height: 10.4cm +*PostIn.width: 3inches + + +XmNunitType can have the following values: + + + +XmPIXELS + +All values provided to the widget are treated as normal +pixel values. + + + + +XmMILLIMETERS + +All values provided to the widget are treated as normal millimeter +values. + + + + +Xm100TH_MILLIMETERS + +All values provided to the widget are treated +as 1/100 of a millimeter. + + + + +XmCENTIMETERS + +All values provided to the widget are treated as normal centimeter +values. + + + + +XmINCHES + +All values provided to the widget are treated as normal inch +values. + + + + +Xm1000TH_INCHES + +All values provided to the widget are treated as +1/1000 of an inch. + + + + +XmPOINTS + +All values provided to the widget are treated as normal point +values. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +All values provided to the widget are treated as +1/100 of a point. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as normal font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are +treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + + + + +XmNuserData + +Allows the application to attach +any necessary specific data to the widget. This is an internally +unused resource. + + + + + + +Dynamic Color Defaults +The foreground, background, top shadow, bottom shadow, and +highlight color resources are dynamically defaulted. +If no color data is specified, the colors are +automatically generated. On a single-plane system, a black and white color +scheme is generated. Otherwise, four colors are +generated, which display the correct shading for the 3-D visuals. +If the background is the only color specified for a widget, the top +shadow and bottom shadow colors are generated to give the 3-D appearance. +Foreground and highlight colors are generated to provide sufficient +contrast with the background color. + +Colors are generated only at creation. Resetting the background through +XtSetValues does not regenerate the other colors. +XmChangeColor can be used to recalculate all associated colors +based on a new background color. + + + +Inherited Resources +Manager inherits resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback for +XmNhelpCallback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + + +reason + +Indicates why the callback was invoked. +For this callback, reason is set to XmCR_HELP. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +A pointer to the following structure is passed to each callback for +XmNpopupHandlerCallback: + +typedef struct +{ + int reason; + XEvent * xevent; + Widget menuToPost; + Boolean postIt; + Widget target; +} XmPopupHandlerCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +xevent + +Points to the XEvent that triggered the handler. + + + + +menuToPost + +Specifies the popup menu that the menu system believes should be +posted. The application may modify this field. + + + + +postIt + +Indicates whether the posting process should continue. The +application may modify this field. + + + + +target + +Specifies the most specific widget or gadget that the menu sytem found +from the event that matches the event. + + + + + + + + + + + + + + + + +Translations +The following set of translations are used by Manager widgets that +have Gadget children. Because Gadgets cannot have translations associated +with them, it is the responsibility of the Manager widget to intercept the +events of interest and pass them to any Gadget child with focus. +These events are ignored if no Gadget child has the focus. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +BtnMotion: + +ManagerGadgetButtonMotion() + + + + +c<Btn1Down>: + +ManagerGadgetTraverseCurrent() + + + + +≈cBtn1Down: + +ManagerGadgetArm() + + + + +≈cBtn1Down,≈cBtn1Up: + +ManagerGadgetActivate() + + + + +≈cBtn1Up: + +ManagerGadgetActivate() + + + + +≈cBtn1Down(2+): + +ManagerGadgetMultiArm() + + + + +≈cBtn1Up(2+): + +ManagerGadgetMultiActivate() + + + + +Btn2Down: + +ManagerGadgetDrag() + + + + +:KeyosfActivate: + +ManagerParentActivate() + + + + +:KeyosfCancel: + +ManagerParentCancel() + + + + +:KeyosfSelect: + +ManagerGadgetSelect() + + + + +:KeyosfHelp: + +ManagerGadgetHelp() + + + + +≈s ≈m ≈a KeyReturn: + +ManagerParentActivate() + + + + +≈s ≈m ≈a Keyspace: + +ManagerGadgetSelect() + + + + +Key: + +ManagerGadgetKeyInput() + + + + +:KeyosfBeginLine: + +ManagerGadgetTraverseHome() + + + + +:KeyosfUp: + +ManagerGadgetTraverseUp() + + + + +:KeyosfDown: + +ManagerGadgetTraverseDown() + + + + +:KeyosfLeft: + +ManagerGadgetTraverseLeft() + + + + +:KeyosfRight: + +ManagerGadgetTraverseRight() + + + + +s ≈m ≈a KeyTab: + +ManagerGadgetPrevTabGroup() + + + + +≈m ≈a KeyTab: + +ManagerGadgetNextTabGroup() + + + + + + + +Action Routines +The XmManager action routines are + + + +GadgetTakeFocus(): + +Causes the current gadget to take keyboard focus when +Ctrl<Btn1Down> is pressed. + + + + +ManagerGadgetActivate(): + +Causes the current gadget to be activated. + + + + +ManagerGadgetArm(): + +Causes the current gadget to be armed. + + + + +ManagerGadgetButtonMotion(): + +Causes the current gadget to process a mouse motion event. + + + + +ManagerGadgetDrag(): + +Causes the current gadget to begin a drag operation. +This action is undefined for gadgets used in a menu system. + + + + +ManagerGadgetHelp(): + +Calls the callbacks for the current gadget's XmNhelpCallback if +any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +ManagerGadgetKeyInput(): + +Causes the current gadget to process a keyboard event. + + + + +ManagerGadgetMultiActivate(): + +Causes the current gadget to process a multiple mouse click. + + + + +ManagerGadgetMultiArm(): + +Causes the current gadget to process a multiple mouse button press. + + + + +ManagerGadgetNextTabGroup(): + +This action depends on the value of the Display resource +XmNenableButtonTab. When XmNenableButtonTab is False +(default), this action traverses to the first item in the next tab +group. If the current tab group is the last entry in the tab group +list, it wraps to the beginning of the tab group list. + +When XmNenableButtonTab is True, this action moves to the next +item within the current tab group, unless it is the last item in the +tab group. When the item is the last in the group, the action +traverses to the first item in the next tab group. The +XmNenableButtonTab behavior applies only to PushButton, ArrowButton, +and DrawnArrow. + + + + +ManagerGadgetPrevTabGroup(): + +This action depends on the value of the Display resource +XmNenableButtonTab. When XmNenableButtonTab is False +(default), this action traverses to the first item in the previous tab +group. If the beginning of the tab group list is reached, it wraps to +the end of the tab group list. + +When XmNenableButtonTab is True, this action moves to the +previous item within the current tab group unless it is the first item +in the tab group. When the item is the first in the group, the action +traverses to the first item in the previous tab group. The +XmNenableButtonTab behavior applies only PushButton, ArrowButton, and +DrawnButton. + + + + +ManagerGadgetSelect(): + +Causes the current gadget to be armed and activated. + + + + +ManagerGadgetTraverseCurrent + +Causes the current gadget to take keyboard focus +when Ctrl<Btn1Down> is pressed. Gadget is not activated. + + + + +ManagerGadgetTraverseDown(): + +Traverses to the next item below the current gadget in the current tab +group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerGadgetTraverseHome(): + +Traverses to the first widget or gadget in the current tab group. + + + + +ManagerGadgetTraverseLeft(): + +Traverses to the next item to the left of the current gadget in the +current tab group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerGadgetTraverseNext(): + +Traverses to the next item in the current tab group, wrapping if +necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerGadgetTraversePrev(): + +Traverses to the previous item in the current tab group, wrapping if +necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerGadgetTraverseRight() + +Traverses to the next item to the right of the current gadget in the +current tab, wrapping if necessary. +widget tab group. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerGadgetTraverseUp(): + +Traverses to the next item above the current gadget in the current tab +group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +ManagerParentActivate(): + +If the parent is a manager, +passes the osfActivate event received by the current widget/gadget +to its parent. + + + + +ManagerParentCancel(): + +If the parent is a manager, +passes the osfCancel event received by the current widget/gadget +to its parent. + + + + + + +Additional Behavior +This widget has the additional behavior described below: + + + +FocusIn: + +If the shell's keyboard focus policy is XmEXPLICIT and the event +occurs in a gadget, causes the gadget to be highlighted and to take the +focus. + + + + +FocusOut: + +If the shell's keyboard focus policy is XmEXPLICIT and the event +occurs in a gadget, causes the gadget to be unhighlighted and to lose +the focus. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmDirection;, +&cdeman.XmChangeColor;, +&cdeman.XmGadget;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MapSeg.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MapSeg.sgm new file mode 100644 index 00000000..8687b61e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MapSeg.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmMapSegmentEncoding +library call + + +XmMapSegmentEncoding +A compound string function that returns +the compound text encoding format associated with the specified font list tag + +XmMapSegmentEncoding + +compound string functions +XmMapSegmentEncoding + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +char * XmMapSegmentEncoding + +char *fontlist_tag + + + +DESCRIPTION +XmMapSegmentEncoding searches the segment encoding registry for +an entry that matches the specified font list tag and returns a copy +of the associated compound text encoding format. The application is +responsible for freeing the storage associated with the returned data +by calling XtFree. + + + +fontlist_tag + +Specifies the compound string font list tag + + + + + + +RETURN +Returns a copy of the associated compound text encoding format +if the font list tag is found in the registry; otherwise, returns NULL. + + + +RELATED +&cdeman.XmCvtXmStringToCT;, +&cdeman.XmFontList;, +&cdeman.XmRegisterSegmentEncoding;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuPos.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuPos.sgm new file mode 100644 index 00000000..f24639b4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuPos.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmMenuPosition +library call + + +XmMenuPosition +A RowColumn function that positions a Popup menu pane + +XmMenuPosition + +RowColumn functions +XmMenuPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +void XmMenuPosition + +Widget menu +XButtonPressedEvent * event + + + +DESCRIPTION +XmMenuPosition positions a Popup menu pane using the information in the +specified event. Unless an application is positioning the menu pane +itself, it must first invoke this function before managing the PopupMenu. +The x_root and y_root +fields +in the specified +X +event are used to +determine the menu position. + + + +menu + +Specifies the PopupMenu to be positioned + + + + +event + +Specifies the event passed to the action procedure which manages the +PopupMenu + + + + +Which corner of the PopupMenu is positioned at the x_root and +y_root +depends on the XmNlayoutDirection resource of the widget from +which popup occurs. + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RELATED +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuSh.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuSh.sgm new file mode 100644 index 00000000..b426fb35 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MenuSh.sgm @@ -0,0 +1,684 @@ + + + + + + + + + + + +XmMenuShell +library call + + +XmMenuShell +The MenuShell widget class + +XmMenuShell + +widget class +MenuShell + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/MenuShell.h> + + + +DESCRIPTION +The MenuShell widget is a custom OverrideShell widget. An OverrideShell +widget bypasses mwm when displaying itself. It is designed +specifically to contain Popup or Pulldown menu panes. + +Most application writers never encounter this widget if they use the +menu-system convenience functions, +XmCreatePopupMenu or XmCreatePulldown Menu, +to create a Popup or Pulldown menu pane. +The convenience functions automatically create a MenuShell widget as the +parent of the menu pane. However, if the convenience functions are +not used, the application programmer must create +the required MenuShell. In this case, it is important to note that the +parent of the MenuShell depends on the type of menu system +being built. + + + +If the MenuShell is for the top-level Popup menu pane, the MenuShell's +parent must be the widget from which the Popup menu pane is popped up. + + + +If the MenuShell is for a menu pane that is pulled down from a Popup or +another Pulldown menu pane, the MenuShell's parent must be the Popup or +Pulldown menu pane. + + + +If the MenuShell is for a menu pane that is pulled down from a MenuBar, +the MenuShell's parent must be the MenuBar. + + + +If the MenuShell is for a Pulldown menu pane in an OptionMenu, the +MenuShell's parent must be the OptionMenu's parent. + + + +Setting XmNheight, XmNwidth, or XmNborderWidth for +either a MenuShell or its child sets that resource to the same value +in both the parent and the child. +An application should always specify these resources for the child, not +the parent. + +For the managed child of a MenuShell, regardless of the value of +the shell's XmNallowShellResize, setting XmNx or XmNy +sets the corresponding resource of the parent but does not change the +child's position relative to the parent. +XtGetValues for the child's XmNx or XmNy yields the +value of the corresponding resource in the parent. +The x and y-coordinates of the child's upper left outside +corner relative to the parent's upper left inside corner are both 0 (zero) +minus the value of XmNborderWidth. + +MenuShell uses the XmQTmenuSystem trait and holds the +XmQTspecifyRenderTable trait. + + +Classes +MenuShell inherits behavior, resources, and traits from Core, +Composite, Shell, and +OverrideShell. + +The class pointer is xmMenuShellWidgetClass. + +The class name is XmMenuShell. + + + +New Resources +MenuShell overrides the XmNallowShellResize resource in Shell. +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmMenuShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +NULL +CSG + + +XmNdefaultFontList +XmCDefaultFontList +XmFontList +dynamic +CG + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +XmLEFT_TO_RIGHT +CG + + + + + + +XmNbuttonFontList + +Specifies the font list used for button descendants. See the +XmNbuttonRenderTable resource. + + + + +XmNbuttonRenderTable + +Specifies the render table used for MenuShell's button descendants. +If this value is NULL at initialization and if the value of +XmNdefaultFontList is not NULL, XmNbuttonRenderTable +is initialized to the value of XmNdefaultFontList. If +the value of XmNdefaultFontList is NULL, XmNbuttonRenderTable +is initialized by looking up the parent hierarchy of the widget for +an ancestor that holds the XmQTspecifyRenderTable trait. +If such an ancestor is found, +XmNbuttonRenderTable is initialized to the +XmBUTTON_RENDER_TABLE value +of the ancestor widget. If no such ancestor is found, the default +is implementation dependent. +Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNdefaultFontList + +Specifies a default font list for MenuShell's descendants. +This resource is obsolete and exists for compatibility with +earlier releases. It has been replaced by XmNbuttonFontList +and XmNlabelFontList. + + + + +XmNlabelFontList + +Specifies the font list used for label descendants. See the +XmNlabelRenderTable resource. + + + + +XmNlabelRenderTable + +Specifies the render table used for MenuShell's label descendants +(Labels and LabelGadgets). If this value is NULL at initialization +and if the value of XmNdefaultFontList is not NULL, +XmNlabelRenderTable is initialized to the value of +XmNdefaultFontList. If the value of XmNdefaultFontList is +NULL, the parent hierarchy of the widget is searched +for an ancestor that holds the XmQTspecifyRenderTable trait. +If such +an ancestor is found, XmNlabelRenderTable is initialized to the +XmLABEL_RENDER_TABLE value of the ancestor widget. If no such ancestor +is found, the default is implementation dependent. Refer to +&cdeman.XmRenderTable; for more information on the creation and structure +of a render table. + + + + +XmNlayoutDirection + +Specifies the direction in which the subwidgets, children of a +widget, or other visual components are to be laid out. This policy +will apply as the default layout policy for all descendants of this +MenuShell. + + + + + + +Inherited Resources +MenuShell inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. +The programmer can set the resource values for these +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), +or is not applicable (N/A). + + + + + + + + + + + +Shell Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowShellResize +XmCAllowShellResize +Boolean +True +G + + +XmNcreatePopupChildProc +XmCCreatePopupChildProc +XtCreatePopupChildProc +NULL +CSG + + +XmNgeometry +XmCGeometry +String +NULL +CSG + + +XmNoverrideRedirect +XmCOverrideRedirect +Boolean +True +CSG + + +XmNpopdownCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpopupCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNsaveUnder +XmCSaveUnder +Boolean +True +CSG + + +XmNvisual +XmCVisual +Visual * +CopyFromParent +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +The XmMenuShell translations are described in the following list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +BtnDown: + +ClearTraversal() + + + + +BtnUp: + +MenuShellPopdownDone() + + + + + + + +Action Routines +The XmMenuShell action routines are + + + +ClearTraversal(): + +Disables keyboard traversal for the menu, enables mouse traversal, and +unposts any menus posted by this menu. + + + + +MenuShellPopdownDone(): + +Unposts the menu hierarchy and, when the shell's keyboard focus policy is +XmEXPLICIT, +restores focus to the widget that had +the focus before the menu system was entered. + + + + +MenuShellPopdownOne(): + +In a top-level Pulldown MenuPane from a MenuBar, this action unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, this action unposts the menu. + +In a Popup MenuPane, this action unposts the menu, and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to the +widget from which the menu was posted. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Core;, &cdeman.OverrideShell;, &cdeman.Shell;, +&cdeman.XmCreateMenuShell;, +&cdeman.XmCreatePopupMenu;, &cdeman.XmCreatePulldownMenu;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBA.sgm new file mode 100644 index 00000000..c2d2e44c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBA.sgm @@ -0,0 +1,1202 @@ + + + + + + + + + + + +XmMessageBox +library call + + +XmMessageBox +The MessageBox widget class + +XmMessageBox + +widget class +MessageBox + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/MessageB.h> + + + +DESCRIPTION +MessageBox is a dialog class used for creating simple message dialogs. +Convenience dialogs based on MessageBox are provided for several common +interaction tasks, which include giving information, asking questions, and +reporting errors. + +A MessageBox dialog is typically transient in nature, displayed for the +duration of a single interaction. +MessageBox is a subclass of BulletinBoard and +depends on it for much of its general dialog behavior. + +The default value for XmNinitialFocus +is the value of XmNdefaultButton. + +A typical MessageBox contains a message symbol, a message, and up to +three standard default PushButtons: OK, Cancel, and Help. +It is laid out with the symbol and message on top and the +PushButtons on the bottom. The Help button is positioned to the side +of the other push buttons. +You can localize the default symbols and button labels for MessageBox +convenience dialogs. + +The user can specify resources in a resource file for the gadgets +created automatically that contain the MessageBox symbol pixmap +and separator. The gadget names are Symbol and Separator. + +A MessageBox can also be customized by creating and managing new +children that are added to the MessageBox children created +automatically by the convenience dialogs. +In the case of +TemplateDialog, only the separator child is created by default. +If the callback, string, or pixmap symbol resources are specified, +the appropriate child will be created. + +Additional children are laid out in the following manner: + + + +The first MenuBar child is placed at the top of the window. +The XmQTmenuSystem trait is used to check that it is the first +MenuBar child. + + + +All widgets or gadgets +are placed after the OK button in the order of their creation +(this order is checked using the XmQTactivatable trait). + + + +A child that is not in the above categories is placed above +the row of buttons. If a message label exists, the child is placed below +the label. If a message pixmap exists, but a message label is absent, the +child is placed on the same row as the pixmap. The child behaves as a +work area and grows or shrinks to fill the space above the +row of buttons. The layout of multiple work area children is +undefined. + + + +At initialization, MessageBox looks for the following bitmap files: + + + +xm_error + + + +xm_information + + + +xm_question + + + +xm_working + + + +xm_warning + + + +See &cdeman.XmGetPixmap; for a list of the paths that are searched for +these files. + +MessageBox uses the XmQTactivatable and XmQTmenuSystem traits. + + +Descendants +MessageBox automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +Cancel +XmPushButtonGadget +Cancel button + + +Help +XmPushButtonGadget +Help button + + +Message +XmLabelGadget +displayed message + + +OK +XmPushButtonGadget +OK button + + +Separator +XmSeparatorGadget +dividing line between message and buttons + + +Symbol +XmLabelGadget +icon symbolizing message type + + + + + + +Classes +MessageBox inherits behavior, resources, and traits from Core, +Composite, Constraint, +XmManager, and XmBulletinBoard. + +The class pointer is xmMessageBoxWidgetClass. + +The class name is XmMessageBox. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmMessageBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNcancelCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcancelLabelString +XmCCancelLabelString +XmString +dynamic +CSG + + +XmNdefaultButtonType +XmCDefaultButtonType +unsigned char +XmDIALOG_OK_BUTTON +CSG + + +XmNdialogType +XmCDialogType +unsigned char +XmDIALOG_MESSAGE +CSG + + +XmNhelpLabelString +XmCHelpLabelString +XmString +dynamic +CSG + + +XmNmessageAlignment +XmCAlignment +unsigned char +XmALIGNMENT_BEGINNING +CSG + + +XmNmessageString +XmCMessageString +XmString +"" +CSG + + +XmNminimizeButtons +XmCMinimizeButtons +Boolean +False +CSG + + +XmNokCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNokLabelString +XmCOkLabelString +XmString +dynamic +CSG + + +XmNsymbolPixmap +XmCPixmap +Pixmap +dynamic +CSG + + + + + + +XmNcancelCallback + +Specifies the list of callbacks that is called when +the user clicks on the cancel button. +The reason sent by the callback is XmCR_CANCEL. + + + + +XmNcancelLabelString + +Specifies the string label for the cancel button. +The default for this resource depends on the locale. +In the C locale the default is Cancel. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNdefaultButtonType + +Specifies the default PushButton. +A value of XmDIALOG_NONE means that there should be no default +PushButton. +The following types are valid: + + + +XmDIALOG_CANCEL_BUTTON + + + +XmDIALOG_OK_BUTTON + + + +XmDIALOG_HELP_BUTTON + + + +XmDIALOG_NONE + + + + + + + +XmNdialogType + +Specifies the type of MessageBox dialog, which determines +the default message symbol. +The following are the possible values for this resource: + + + +XmDIALOG_ERROR + +Indicates an ErrorDialog. + + + + +XmDIALOG_INFORMATION + +Indicates an InformationDialog. + + + + +XmDIALOG_MESSAGE + +Indicates a MessageDialog. +This is the default MessageBox dialog type. +It does not have an associated message symbol. + + + + +XmDIALOG_QUESTION + +Indicates a QuestionDialog. + + + + +XmDIALOG_TEMPLATE + +Indicates a TemplateDialog. +The TemplateDialog contains only a separator child. It does not +have an associated message symbol. + + + + +XmDIALOG_WARNING + +Indicates a WarningDialog. + + + + +XmDIALOG_WORKING + +Indicates a WorkingDialog. + + + + +If this resource is changed with XtSetValues, the symbol bitmap is +modified to the new XmNdialogType bitmap unless +XmNsymbolPixmap is also being set in the call to +XtSetValues. +If the dialog type does not have an associated message symbol, then no +bitmap will be displayed. + + + + +XmNhelpLabelString + +Specifies the string label for the help button. +The default for this resource depends on the locale. +In the C locale the default is Help. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNmessageAlignment + +Controls the alignment of the message Label. +Possible values include the following: + + + +XmALIGNMENT_BEGINNING (default) + + + +XmALIGNMENT_CENTER + + + +XmALIGNMENT_END + + + + +See the description of XmNalignment in the XmLabel +reference page for an explanation of these values. + + + + +XmNmessageString + +Specifies the string to be used as the message. + + + + +XmNminimizeButtons + +Sets the buttons to the width of the widest button and height of the +tallest button if False. If this resource is True, +button width and height are +set to the preferred size of each button. + + + + +XmNokCallback + +Specifies the list of callbacks that is called when +the user clicks on the OK button. +The reason sent by the callback is XmCR_OK. + + + + +XmNokLabelString + +Specifies the string label for the OK button. +The default for this resource depends on the locale. +In the C locale the default is OK. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNsymbolPixmap + +Specifies the pixmap label to be used as the message symbol. + + + + + + +Inherited Resources +MessageBox inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +True +CG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +Cancel button +SG + + +XmNdefaultButton +XmCWidget +Widget +dynamic +SG + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +True +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent *event; +} XmAnyCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + + + + + + + + + + + + + +Translations +XmMessageBox includes the translations from XmManager. + + + +Additional Behavior +The XmMessageBox widget has the following additional behavior: + + + +KeyosfCancel: + +Calls the activate callbacks for the cancel button if it is sensitive. + + + + +KeyosfActivate: + +Calls the activate callbacks for the button with the keyboard focus. +If no button has the keyboard focus, calls the activate callbacks +for the default button if it is sensitive. + + + + +Ok Button Activated: + +Calls the callbacks for XmNokCallback. + + + + +Cancel Button Activated: + +Calls the callbacks for XmNcancelCallback. + + + + +Help Button Activated: + +Calls the callbacks for XmNhelpCallback. + + + + +FocusIn: + +Calls the callbacks for XmNfocusCallback. + + + + +Map: + +Calls the callbacks for XmNmapCallback if the parent is a +DialogShell. + + + + +Unmap: + +Calls the callbacks for XmNunmapCallback if the parent is a +DialogShell. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmBulletinBoard;, +&cdeman.XmCreateErrorDialog;, +&cdeman.XmCreateInformationDialog;, +&cdeman.XmCreateMessageBox;, +&cdeman.XmCreateMessageDialog;, +&cdeman.XmCreateQuestionDialog;, +&cdeman.XmCreateTemplateDialog;, +&cdeman.XmCreateWarningDialog;, +&cdeman.XmCreateWorkingDialog;, +&cdeman.XmManager;, and +&cdeman.XmMessageBoxGetChild;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBB.sgm new file mode 100644 index 00000000..4c2d6aec --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/MsgBB.sgm @@ -0,0 +1,131 @@ + + + + + + + + + + + +XmMessageBoxGetChild +library call + + +XmMessageBoxGetChild +A MessageBox function that is used to access a component + +XmMessageBoxGetChild + +MessageBox functions +XmMessageBoxGetChild + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/MessageB.h> + +Widget XmMessageBoxGetChild + +Widget widget +unsigned char child + + + +DESCRIPTION +XmMessageBoxGetChild is used to access a component within a MessageBox. +The parameters given to the function are the MessageBox widget and a value +indicating which component to access. + +NOTE: This routine is obsolete and exists for compatibility with previous +releases. Instead of calling XmMessageBoxGetChild, you should +call XtNameToWidget as described in the &cdeman.XmMessageBox; +reference page. + + + +widget + +Specifies the MessageBox widget ID. + + + + +child + +Specifies a component within the MessageBox. The following are legal values +for this parameter: + + + +XmDIALOG_CANCEL_BUTTON + + + +XmDIALOG_DEFAULT_BUTTON + + + +XmDIALOG_HELP_BUTTON + + + +XmDIALOG_MESSAGE_LABEL + + + +XmDIALOG_OK_BUTTON + + + +XmDIALOG_SEPARATOR + + + +XmDIALOG_SYMBOL_LABEL + + + + + + + +For a complete definition of MessageBox and its associated resources, see +&cdeman.XmMessageBox;. + + + +RETURN +Returns the widget ID of the specified MessageBox component. +An application should not assume that the returned widget will be of any +particular class. + + + +RELATED +&cdeman.XmMessageBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/NotebG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/NotebG.sgm new file mode 100644 index 00000000..843c4856 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/NotebG.sgm @@ -0,0 +1,182 @@ + + + + + + + + + + + +XmNotebookGetPageInfo +library call + + +XmNotebookGetPageInfo +A Notebook function that returns page information + +XmNotebookGetPageInfo + +Notebook functions +XmNotebookGetPageInfo + + + + + + + + + + + + + + + +#include <Xm/Notebook.h> + +XmNotebookPageStatus XmNotebookGetPageInfo + +Widget notebook +int page_number +XmNotebookPageInfo *page_info + + + +DESCRIPTION +XmNotebookGetPageInfo returns status information for the specified +Notebook page. + + + +notebook + +Specifies the Notebook widget. + + + + +page_number + +Specifies the page number to be queried. + + + + +page_info + +Points to the structure containing the page information. The structure +has the following form: + + +typedef struct +{ + int page_number; + Widget page_widget; + Widget status_area_widget; + Widget major_tab_widget; + Widget minor_tab_widget; +} XmNotebookPageInfo; + + + + + + +page_number + +Specifies the page_number passed to the function. + + + + +page_widget + +Specifies a child widget of the Notebook with a XmNchildType of +XmPAGE and a XmNpageNumber equal to page_number if one +exists; otherwise set to NULL. + + + + +status_area_widget + +Specifies a child widget of the Notebook with a XmNchildType of +XmSTATUS_AREA and a XmNpageNumber equal to page_number if one +exists; otherwise set to NULL. + + + + +major_tab_widget + +Specifies a child widget of the Notebook with a XmNchildType of +XmMAJOR_TAB and the nearest XmNpageNumber +equal to or less than page_number if one +exists; otherwise set to NULL. + + + + +minor_tab_widget + +Specifies a child widget of the Notebook with a XmNchildType of +XmMINOR_TAB and the nearest XmNpageNumber +equal to or less than page_number if one +exists; otherwise set to NULL. + + + + + + + +For a complete definition of Notebook and its associated resources, see +&cdeman.XmNotebook;. + + + +RETURN +Returns one of the following page status values: + + + +XmPAGE_FOUND + +The specified page was found. + + + + +XmPAGE_INVALID + +The specified page number is out of the page number range. + + + + +XmPAGE_EMPTY + +The specified page does not have a page widget. + + + + +XmPAGE_DUPLICATED + +There is more than one page widget with the specified page number. The +more recently managed page widget is used for the page information structure. + + + + + + +RELATED +&cdeman.XmNotebook;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Notebook.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Notebook.sgm new file mode 100644 index 00000000..40d9e7a5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Notebook.sgm @@ -0,0 +1,1562 @@ + + + + + + + + + + + +XmNotebook +library call + + +XmNotebook +The Notebook widget class + +XmNotebook + +widget class +Notebook + + + + + + + + + + + + + + +&npzwc;#include <Xm/Notebook.h> + + + +DESCRIPTION +Notebook is a manager widget that +organizes its children into pages, tabs, status areas, and page scrollers to +simulate a real notebook. It stacks its page children so that all page +children occupy the same area like real book pages. +Notebook displays visuals that look like the binding of a book and the +edges of other pages around the page that is shown. +Tab children simulate +notebook tabs. Major tabs divide Notebook into several sections, +and minor tabs subdivide these sections. Status area children provide additional +information about pages such as page numbers. The page scroller child allows +the user to move from page to page. Notebook also provides tab scrollers +for scrolling major and minor tabs if it cannot display all tabs within its +edges. + +The application creates pages, tabs, status areas, and page scroller +as children of the Notebook widget. Notebook creates tab scrollers +when the Notebook is created. + +The XmNnotebookChildType constraint resource +of Notebook determines whether a child widget is a page, tab, status area, +or page scroller. Any Motif widget can be a page of the Notebook. +When the application creates a child of the Notebook widget without setting +the child type constraint, the child becomes a page by default, unless it has +the XmQTactivatable, +XmQTaccessTextual, or XmQTnavigator trait. +Children with the XmQTactivatable, +XmQTaccessTextual, or XmQTnavigator trait become +major tabs, status areas, and page scrollers, respectively. + +Notebook uses the XmQTaccessTextual, XmQTactivatable, +XmQTjoinSide, and +XmQTnavigator traits, and installs the XmQTscrollFrame trait. + +The application attaches a tab to a page by creating a tab child of the +Notebook and setting the XmNpageNumber constraint to the page number of +the targeted page. By the same method, a status area widget can be attached to +a page. The page scroller child, on the other hand, is associated with the +Notebook, not with a specific page. Therefore, there is only one valid page +scroller for each Notebook. + + +Pages +Only one child of type XmPAGE is displayed at a time by Notebook. +Other page children are hidden off-screen. When Notebook displays a particular +page, it positions the previously-displayed page off-screen and puts the new +page in its place. The page is resized to fit into the dimensions that +Notebook has allocated to display pages. + + + +Page Numbers +Notebook uses the XmNcurrentPageNumber, XmNfirstPageNumber, +and XmNlastPageNumber resources to determine the current page and +available page number range. Only those pages whose page numbers are within +the range can be displayed. Other pages cannot be displayed until the range +between XmNfirstPageNumber and XmNlastPageNumber is +changed to include them or their page numbers are changed to a number within +the range. + +If XmNfirstPageNumber and XmNlastPageNumber are not set explicitly +by the application, they are set to 1 by default; Notebook +sets XmNlastPageNumber +to the largest page number assigned by the application thereafter by +default. However, once XmNlastPageNumber is set by the application, +Notebook no longer changes it +even when a page with a higher page number is managed. + +The XmNpageNumber constraint resource is used for specifying the page +number of a page widget. It can be set to any integer. For tab and status area +children, the resource is used for linking the child widget to a page. +For the page scroller child, the resource has no meaning and is ignored by +the Notebook. + +When a page without a page number is managed, Notebook assigns it +the smallest unallocated page number that is not less than +the first page number and greater than the last allocated page number. When +a tab or a status area without a page number is managed, the newly managed +widget is assigned +the page number of the most recently managed page, unless the page already has +the same type of child. If the page does have the same type of child, +Notebook assigns the newly managed widget +a page number one greater than the most recently managed page; +this new page number is now occupied. +Notebook may generate a +default page number greater than XmNlastPageNumber, making +those pages inaccessible to the user. + + + +Duplicate and Empty Pages +Since an application can create or change page numbers, it is possible +to have duplicate page numbers and empty pages. When two pages with the +same page number are managed, only the more recently managed page can be +displayed. Inserting a page with an existing page number +does not cause a warning. The old page widget cannot be displayed +until the new page widget is removed from the Notebook or until the page number +of the old page widget is changed to some other number. + +An empty page is a page +slot where no page is inserted. Empty pages occur when a tab or status area +is associated with a page number that has no matching page widget. +Empty pages display the blank Notebook +background unless the application provides visual information to this +empty area while processing XmNpageChangedCallback. + + + +Notebook Visuals +Notebook draws lines around two sides of the top page +to simulate the edges of other pages that are behind the top page. +The XmNbackPagePlacement and XmNorientation resources determine +which two sides have the lines drawn around them. By default, they are drawn +on the bottom and right sides of the top page. The application can set +resources to control how many lines are drawn and how wide the area that they +are drawn in is. Applications can also choose from three styles of binding +visual that simulates the binding of a Notebook. Solid or spiral bindings +can be drawn by Notebook, or the application can supply a pixmap that is +tiled into the binding. + + + +Tabs +A major or minor tab is a Motif widget with the XmQTactivatable trait. +If a widget without the trait is created +for a tab, Notebook does not provide the page activation callback. +As a result, even though the tab is displayed, it cannot automatically move the +associated page to the top. + +Major tabs divide the Notebook pages into sections. Minor tabs +subdivide these sections. +Only minor tabs associated with the current +section are displayed, where a section consists of the group of pages +between the current major tab and the next major tab, including the +current major tab but not including the page containing the next major tab. +The exception to this is when there is no preceding major tab, in +which case the section starts from the XmNfirstPageNumber value. +A user in one major tab section does not see +the minor tabs in other sections. +However, all tabs are used in computing +the size of the Notebook. + +Unlike regular notebook tabs, tabs in the +Notebook are not attached to a physical page (a widget). They are, instead, +attached to a logical page (a page number). Therefore, it is possible to have +a tab with an empty page. When a page with a tab is removed from the Notebook, +the tab is not removed because it is still bound to a logical page. +Destroying or unmanaging +a page widget only erases the page and leaves an empty page. +It does not tear the page out of the Notebook. To remove the tab, the +application must explicitly destroy or unmanage it. + +Notebook supports the XmQTjoinSide trait. A widget that has the +XmQTjoinSide trait can be added to the Notebook as a Major or Minor +tab and will appear to be attached to its associated page with no margins or +shadows between them. + + + +Status Areas +A status area is any widget that is used for describing +the associated page. For example, the Label widget as a status area child +can hold a simple string or a pixmap that describes a page. A status area +widget is also attached to a page by the page number constraint resource. +Therefore, it is possible to have multiple status area widgets for one page. +Only the most recently managed status area widget for that page can be +displayed. All others for that page are not unmanaged, but their sizes are +used for computing the size of the Notebook. If no status area widget +is provided, the Notebook displays its blank background in the status area's +reserved space. Notebook does not create any default status area widget. + + + +Page Scrollers +The page scroller of the Notebook is any widget that the application +creates for scrolling pages. If the application does not create one when +the Notebook is realized, Notebook creates a SpinBox widget as the +default page scroller. +If the application creates a new page scroller, the default page scroller is +destroyed. If the application creates multiple page scrollers, only the +most recently managed one can be displayed and used. All others are +unmanaged. + +The default SpinBox page scroller grays out one of the arrow visuals +if the current page is a boundary page. +If the current page is the first page, the previous arrow of the SpinBox +is grayed. If the current page is the last page, the next arrow of the +SpinBox is grayed. + + + +Tab Scrollers +Tab scrollers are created by the Notebook for scrolling major tabs and minor +tabs. When Notebook is initialized, it creates four ArrowButtonGadgets +for scrolling to the next major tab, the previous major tab, the next +minor tab, and the previous minor tab. +The application cannot replace these tab scrollers. +The application can change all resources +of these widgets except the position and the arrow direction. Tab scrollers +are only visible and enabled when there is not enough space to display all the +major or minor tabs appropriate to the page. Tab scrollers are also +grayed out when scrolling is inappropriate. The following lists the +tab scrollers that are created: + + + + + + + + +Child Widgets that XmNotebook Creates + + +Child +Name +Widget Class + + +Page Scroller +PageScroller +XmSpinBox + + +Next Major Tab Scroller +MajorTabScrollerNext +XmArrowButtonGadget + + +Previous Major Tab Scroller +MajorTabScrollerPrevious +XmArrowButtonGadget + + +Next Minor Tab Scroller +MinorTabScrollerNext +XmArrowButtonGadget + + +Previous Minor Tab Scroller +MinorTabScrollerPrevious +XmArrowButtonGadget + + + + +When the user selects the page scroller, a major tab, or a minor tab, the value +of XmNcurrentPageNumber is changed to the selected page number and +XmNpageChangedCallback is invoked. After the application returns from +the callback, the Notebook displays the last page child whose page number is +equal to the current page number. It also displays the last matched status +area child. All other pages and status areas are automatically hidden. Major +tabs and minor tabs that can fit into the Notebook's edges are displayed and +positioned appropriately. All other tabs are also hidden. The application +can also cause a page change by calling XtSetValues on +XmNcurrentPageNumber and then calling XtCallCallbacks on +XmNpageChangedCallback. + + + +Orientation +The Notebook has eight different visual configurations, depending on +the value of XmNbackPagePlacement and XmNorientation. These two +resources determine the placement of back pages, the binding, major tabs, +minor tabs, the status area, and the page scroller. The location of the binding +is determined by XmNorientation. +Major tabs are always placed on the back page side opposite to the binding; +Minor tabs are placed on the +back page display area that is visually connected to the binding. +Both Major and Minor tabs are ordered so that the page numbers they access +increase as they get closer to the corner where the back pages meet. +The status area and the page scroller are always located on the bottom +of the Notebook, inside the frame. The page scroller is always placed adjacent +to a back page side. The following table shows the possible configurations +and the locations of each Notebook component within the configuration. +The default back page value +and the default orientation +are based upon XmNlayoutDirection. + + + + + + + + + + +Notebook Configurations + + +XmNbackPagePlacement +XmNorientation +Major Tabs +Status Area +Binding + + + + +Minor Tabs +Page Scroller + + +XmBOTTOM_RIGHT +XmHORIZONTAL +RIGHT +BOTTOM LEFT +LEFT + + + + +BOTTOM +BOTTOM RIGHT + + +XmBOTTOM_RIGHT +XmVERTICAL +BOTTOM +BOTTOM LEFT +TOP + + + + +RIGHT +BOTTOM RIGHT + + +XmBOTTOM_LEFT +XmHORIZONTAL +LEFT +BOTTOM RIGHT +RIGHT + + + + +BOTTOM +BOTTOM LEFT + + +XmBOTTOM_LEFT +XmVERTICAL +BOTTOM +BOTTOM RIGHT +TOP + + + + +LEFT +BOTTOM LEFT + + +XmTOP_RIGHT +XmHORIZONTAL +RIGHT +BOTTOM LEFT +LEFT + + + + +TOP +BOTTOM RIGHT + + +XmTOP_RIGHT +XmVERTICAL +TOP +BOTTOM LEFT +BOTTOM + + + + +RIGHT +BOTTOM RIGHT + + +XmTOP_LEFT +XmHORIZONTAL +LEFT +BOTTOM RIGHT +RIGHT + + + + +TOP +BOTTOM LEFT + + +XmTOP_LEFT +XmVERTICAL +TOP +BOTTOM RIGHT +BOTTOM + + + + +LEFT +BOTTOM LEFT + + + + +There are three tab groups for tab group traversal +inside the Notebook: major tabs, minor tabs, +and the page scroller. +The application can also create additional types of tab groups +within the Notebook; for example, each page added by the application is +treated as a separate tab group by the traversal actions. + + + +Classes +Notebook inherits behavior, resources, and traits from Core, +Composite, Constraint, and XmManager classes. + +The class pointer is xmNotebookWidgetClass. + +The class name is XmNotebook. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in a .Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in a .Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate if the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmNotebook Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackPageBackground +XmCBackPageBackground +Pixel +dynamic +CSG + + +XmNbackPageForeground +XmCBackPageForeground +Pixel +dynamic +CSG + + +XmNbackPageNumber +XmCBackPageNumber +Cardinal +2 +CSG + + +XmNbackPagePlacement +XmCBackPagePlacement +unsigned char +dynamic +CSG + + +XmNbackPageSize +XmCBackPageSize +Dimension +8 +CSG + + +XmNbindingPixmap +XmCBindingPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbindingType +XmCBindingType +unsigned char +XmSPIRAL +CSG + + +XmNbindingWidth +XmCBindingWidth +Dimension +25 +CSG + + +XmNcurrentPageNumber +XmCCurrentPageNumber +int +dynamic +CSG + + +XmNfirstPageNumber +XmCFirstPageNumber +int +1 +CSG + + +XmNframeBackground +XmCFrameBackground +Pixel +dynamic +CSG + + +XmNframeShadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNinnerMarginHeight +XmCInnerMarginHeight +Dimension +0 +CSG + + +XmNinnerMarginWidth +XmCInnerMarginWidth +Dimension +0 +CSG + + +XmNlastPageNumber +XmCLastPageNumber +int +dynamic +CSG + + +XmNminorTabSpacing +XmCMinorTabSpacing +Dimension +3 +CSG + + +XmNmajorTabSpacing +XmCMajorTabSpacing +Dimension +3 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmHORIZONTAL +CSG + + +XmNpageChangedCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +XmNbackPageBackground + +Specifies the background color for drawing back pages. +The default is a lower-intensity version of XmNframeBackground. + + + + +XmNbackPageForeground + +Specifies the forground color for drawing back pages. The default is +taken from the application's default foreground color. + + + + +XmNbackPageNumber + +Specifies the number of lines to draw for back pages. The minimum value is +1, and the maximum value is (XmNbackPageSize / 2). + + + + +XmNbackPagePlacement + +Specifies where to place the back pages. +The default is dependent on the XmNlayoutDirection resource +of the Notebook's instance parents. +It can have one of the following +values: + + + +XmBOTTOM_RIGHT + +Displays back pages on the Notebook's bottom and +right sides. + + + + +XmBOTTOM_LEFT + +Displays back pages on the Notebook's bottom and +left sides. + + + + +XmTOP_RIGHT + +Displays back pages on the Notebook's top and right +sides. + + + + +XmTOP_LEFT + +Displays back pages on the Notebook's top and left sides. + + + + + + + +XmNbackPageSize + +Specifies the thickness of the back page rendering. + + + + +XmNbindingPixmap + +Specifies the pixmap or bitmap for stippling or tiling the binding when +XmNbindingType is XmPIXMAP or XmPIXMAP_OVERLAP_ONLY. + + + + +XmNbindingType + +Specifies the binding type. It can have one of the following values: + + + +XmNONE + +Displays no binding. + + + + +XmSOLID + +Displays a solid binding in the foreground color of the +Notebook within the binding area specified by XmNbindingWidth. + + + + +XmSPIRAL + +Displays a spiral binding in the foreground color of the +Notebook within the area specified by XmNbindingWidth +and within the area outside of the frame equal to +the area specified by XmNbindingWidth. + + + + +XmPIXMAP + +Displays the binding with the pixmap or bitmap specified by +XmNbindingPixmap as a stipple or tile. It uses the foreground color of +the Notebook for stippling. The binding width is decided by the larger value +of XmNbindingWidth and the width of the pixmap or bitmap. + + + + +XmPIXMAP_OVERLAP_ONLY + +Displays the binding with the pixmap or bitmap +specified by XmNbindingPixmap as a stipple or tile. It uses the +foreground color of the Notebook for stippling. The binding is displayed only +within the binding area specified by XmNbindingWidth. + + + + + + + +XmNbindingWidth + +Specifies the width of the Notebook binding. If XmNbindingType is +XmPIXMAP and the width of the pixmap specified in +XmNbindingPixmap is greater than XmNbindingWidth, then this +resource is ignored and the +width of the pixmap is used as the width of the Notebook binding +instead. + + + + +XmNcurrentPageNumber + +Specifies the page number of the currently displayed page. Initially, it is set +to XmNfirstPageNumber. If it is set to less than +XmNfirstPageNumber, +then it is set to XmNfirstPageNumber. +If it is set to XmNlastPageNumber, +then it is set to XmNlastPageNumber. + + + + +XmNfirstPageNumber + +Specifies the page number for the first page of the Notebook. +The Notebook does not scroll to any page numbers below this value. + + + + +XmNframeBackground + +Specifies the background color for drawing the Notebook's frame. + + + + +XmNframeShadowThickness + +Specifies the shadow thickness around the Notebook's frame. + + + + +XmNinnerMarginHeight + +Specifies the margin on the top and bottom sides of the page, status +area, and page scroller widgets. + + + + +XmNinnerMarginWidth + +Specifies the margin on the left and right sides of the page, status +area, and page scroller widgets. + + + + +XmNlastPageNumber + +Specifies the page number for the last page of the Notebook. +The Notebook does not scroll to any page numbers above this value. +The default page number is the largest page number of managed page, +major tab, or minor tab widgets. +If this is set to a value that is less than XmNfirstPageNumber, the +behavior of the Notebook is undefined. + + + + +XmNmajorTabSpacing + +Specifies the spacing distance between major tabs. +If XmNframeShadowThickness is greater than XmNmajorTabSpacing, then +this resource is ignored and the size of XmNframeShadowThickness is +used as the spacing distance between major tabs. + + + + +XmNminorTabSpacing + +Specifies the spacing distance between minor tabs. If +XmNframeShadowThickness is greater than XmNminorTabSpacing, then +this resource is ignored and the size of XmNframeShadowThickness is +used as the spacing distance between minor tabs. + + + + +XmNorientation + +Specifies the orientation of the Notebook. It can have one of the following +values: + + + +XmHORIZONTAL + +Places the binding beside the pages, in the left or +right side of the frame. + + + + +XmVERTICAL + +Places the binding above or below the pages, in the top +or the bottom of the frame. + + + + + + + +XmNpageChangedCallback + +Specifies the list of callbacks to call whenever the +XmNcurrentPageNumber, representing the current page number, is +changed. This includes the point when the widget is realized and the +page number is initialized. +The callback structure is XmNotebookCallbackStruct. +The reason is XmCR_MAJOR_TAB, XmCR_MINOR_TAB, +XmCR_PAGE_SCROLLER_INCREMENT, +XmCR_PAGE_SCROLLER_DECREMENT, or XmCR_NONE, depending +upon what action caused the Notebook to display a new page. + + + + + + + + + + + + + + +XmNotebook Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNnotebookChildType +XmCNotebookChildType +unsigned char +dynamic +CG + + +XmNpageNumber +XmCPageNumber +int +dynamic +CSG + + +XmNresizable +XmCResizable +Boolean +True +CSG + + + + + + +XmNnotebookChildType + +Specifies the child type of the Notebook. It can be one of the following types: + + + +XmPAGE + +The child is a page of the Notebook. This is the default +when the child does not have +the XmQTactivatable, +XmQTaccessTextual, or XmQTnavigator trait. + + + + +XmMAJOR_TAB + +The child is a major tab. This is the default when +the child has the XmQTactivatable trait. + + + + +XmMINOR_TAB + +The child is a minor tab. + + + + +XmSTATUS_AREA + +The child is a status area. This is the default when +the child has the XmQTaccessTextual trait and does not have +the XmQTactivatable trait. + + + + +XmPAGE_SCROLLER + +The child is the page scroller. The default page +scroller is destroyed, if it exists. Any previously created page +scrollers are unmanaged. This is the default when the child +has the XmQTnavigator trait and does have the +XmQTactivatable trait or the XmQTaccessTextual trait. + + + + + + + +XmNpageNumber + +Specifies the page number associated with the widget. +If the widget is a page, the number specifies the page number of the widget. +If the widget is not a page, the number specifies the page number of the +associated page. If none is supplied by the application, Notebook +generates the smallest unallocated page number when the child is managed. +This resource is ignored for the page scroller. + + + + +XmNresizable + +Specifies whether this child can request a resize. + + + + + + +Inherited Resources +Notebook inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback +A pointer to the following structure is passed to callbacks for +XmNpageChangedCallback. + +typedef struct +{ + int reason; + XEvent *event; + int page_number; + Widget page_widget; + int prev_page_number; + Widget prev_page_widget; +} XmNotebookCallbackStruct; + + +reason + +Specifies the reason for the callback. + + + + +event + +Points to the XEvent that triggered the callback. It can be NULL. + + + + +page_number + +Indicates the page number to be displayed. + + + + +page_widget + +Indicates the page widget that has the new page number. +It is NULL if no page widget with the page number is found. + + + + +prev_page_number + +Indicates the page number of the currently displayed page. If the +callback procedure is being called at widget initialization, this page +number will be returned as XmUNSPECIFIED_PAGE_NUMBER. + + + + +prev_page_widget + +Indicates the currently displayed page widget. If the callback +procedure is being called at widget initialization, NULL will be +returned. + + + + + + + + + + + + + + +Translations +Notebook inherits translations from Manager. + + + +Accelerators +Notebook accelerators are added to all major tab and minor tab +children of XmNotebook. +Notebook accelerators are listed below. +These accelerators might not directly correspond to a +translation table. + + + +osfBeginLine: + +TraverseTab(Home) + + + + +osfEndLine: + +TraverseTab(End) + + + + +osfLeft: + +TraverseTab(Previous) + + + + +osfRight: + +TraverseTab(Next) + + + + +osfUp: + +TraverseTab(Previous) + + + + +osfDown: + +TraverseTab(Next) + + + + + + +Action Routines +Notebook action routines are described below: + + + +TraverseTab(Home|End|Next|Previous) + +Moves the focus on major or minor tabs. + + + + + + +Additional Behavior +The Notebook widget has the additional behavior described below: + + + +Tab + +Notebook intercepts tab group traversal when traversal is entering or +leaving major or minor tabs. It does this to support major tabs and minor +tabs as two separate tab groups when they are actually treated as one +by traversal. If a minor tab has keyboard focus and a user or program +action specifies XmTRAVERSE_PREV_TAB_GROUP, keyboard focus will +go to a major tab. If a major tab has keyboard focus and a user or program +action specifies XmTRAVERSE_NEXT_TAB_GROUP, keyboard focus will +go to a minor tab. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmCreateNotebook;, +&cdeman.XmManager;, and +&cdeman.XmNotebookGetPageInfo;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ObjectAP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ObjectAP.sgm new file mode 100644 index 00000000..082298d5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ObjectAP.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmObjectAtPoint +library call + + +XmObjectAtPoint +A toolkit function that determines which child intersects or comes closest to a specified point + +XmObjectAtPoint + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmObjectAtPoint + +Widget widget +Position x +Position y + + + +DESCRIPTION +XmObjectAtPoint searches the child list of the specified +manager widget and returns the child most closely associated +with the specified x,y coordinate pair. + +For the typical Motif manager widget, XmObjectAtPoint +uses the following rules to determine the returned object: + + + +If one child intersects x,y, XmObjectAtPoint +returns the widget ID of that child. + + + +If more than one child intersects x,y, +XmObjectAtPoint returns the widget ID of the visible child. + + + +If no child intersects x,y, XmObjectAtPoint +returns NULL. + + + +The preceding rules are only general. In fact, each manager +widget is free to define "most closely associated" +as it desires. +For example, if no child intersects x,y, a manager +might return the child closest to x,y. + + + +widget + +Specifies a manager widget. + + + + +x + +Specifies the x-coordinate about which you are seeking child +information. The x-coordinate must be specified in pixels, +relative to the left side of manager. + + + + +y + +Specifies the y-coordinate about which you are seeking child +information. The y-coordinate must be specified in pixels, +relative to the top side of manager. + + + + + + +RETURN +Returns the child of manager most closely associated +with x,y. +If none of its children are sufficiently associated with x,y, +returns NULL. + + + +RELATED +&cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionBu.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionBu.sgm new file mode 100644 index 00000000..56cbbc92 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionBu.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmOptionButtonGadget +library call + + +XmOptionButtonGadget +A RowColumn function that obtains the widget ID for the CascadeButtonGadget in an OptionMenu + +XmOptionButtonGadget + +RowColumn functions +XmOptionButtonGadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmOptionButtonGadget + +Widget option_menu + + + +DESCRIPTION +XmOptionButtonGadget provides the application with the means for +obtaining the widget ID for the internally created CascadeButtonGadget. Once +the application has obtained the widget ID, it can +adjust the visuals for the CascadeButtonGadget, if desired. + +When an application creates an instance of the OptionMenu widget, the +widget creates two internal gadgets. One is a LabelGadget that is +used to display RowColumn's XmNlabelString resource. +The other is a CascadeButtonGadget that displays the current selection +and provides the means for posting the OptionMenu's submenu. + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. The following list +identifies the names of these widgets (or gadgets) and the associated +OptionMenu areas. + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + + + +option_menu + +Specifies the OptionMenu widget ID + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the widget ID for the internal button. + + + +RELATED +&cdeman.XmCreateOptionMenu;, &cdeman.XmCascadeButtonGadget;, +&cdeman.XmOptionLabelGadget;, +and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionLa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionLa.sgm new file mode 100644 index 00000000..60bc3783 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/OptionLa.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmOptionLabelGadget +library call + + +XmOptionLabelGadget +A RowColumn function that obtains the widget ID for the LabelGadget in an OptionMenu + +XmOptionLabelGadget + +RowColumn functions +XmOptionLabelGadget + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmOptionLabelGadget + +Widget option_menu + + + +DESCRIPTION +XmOptionLabelGadget +provides the application with the means for obtaining the +widget ID for the internally created LabelGadget. +Once the application has obtained the widget ID, it can +adjust the visuals for the LabelGadget, if desired. + + + +option_menu + +Specifies the OptionMenu widget ID + + + + +When an application creates an instance of the OptionMenu widget, the +widget creates two internal gadgets. One is a LabelGadget that is used +to display RowColumn's XmNlabelString resource. The other +is a CascadeButtonGadget that displays the current selection and provides +the means for posting the OptionMenu's submenu. + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. The following list +identifies the names of these widgets (or gadgets) and the associated +OptionMenu areas. + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the widget ID for the internal label. + + + +RELATED +&cdeman.XmCreateOptionMenu;, &cdeman.XmLabelGadget;, +&cdeman.XmOptionButtonGadget;, and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PanedWin.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PanedWin.sgm new file mode 100644 index 00000000..9806a3b5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PanedWin.sgm @@ -0,0 +1,1107 @@ + + + + + + + + + + + +XmPanedWindow +library call + + +XmPanedWindow +The PanedWindow widget class + +XmPanedWindow + +widget class +PanedWindow + + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/PanedW.h> + + + +DESCRIPTION +PanedWindow is a composite widget that lays out children in a +vertically tiled format. Children appear in top-to-bottom fashion, with +the first child inserted appearing at the top of the PanedWindow and the +last child inserted appearing at the bottom. The +PanedWindow grows to match the width of its widest child and all +other children are forced to this width. The height of the PanedWindow +is equal to the sum of the heights of all its children, the spacing +between them, and the size of the top and bottom margins. + +The user can also adjust the size of the panes. To +facilitate this adjustment, a pane control sash is created for most +children. The sash appears as a square box positioned on the bottom of +the pane that it controls. The user can adjust the size of +a pane by using the mouse or keyboard. + +The PanedWindow is also a constraint widget, which means that it +creates and manages a set of constraints for each child. You can +specify a minimum and maximum size for each pane. The PanedWindow +does not allow a pane to be resized below its minimum size or beyond its +maximum size. Also, when the minimum size of a pane is equal to its maximum +size, no control sash is presented for that pane or +for the lowest pane. + +The default XmNinsertPosition procedure for PanedWindow causes +all panes to appear first in the XmNchildren list and +all sashes to appear after the panes. For a pane child, it returns the +value of XmNpositionIndex if one has been specified for the +child. Otherwise, it returns the number of panes in the +PanedWindow's XmNchildren list. Other than the fact that all +sashes appear after all panes, the insertion order of sashes is unspecified. +This procedure also causes +nonsash widgets to be inserted after other nonsash children but before +any sashes. +The behavior of PanedWindow is undefined if XmNinsertPosition is set +to a procedure other than the default. + +All panes and sashes in a PanedWindow must be tab groups. When a pane is +inserted as a child of the PanedWindow, if the pane's +XmNnavigationType is not XmEXCLUSIVE_TAB_GROUP, PanedWindow +sets it to XmSTICKY_TAB_GROUP. + + +Descendants +PanedWindow automatically creates for each paned window the +descendants shown in the +following table. +An application can use XtName and the child list information to +gain access to the named descendant. +In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +Sash +subclass of XmPrimitive +sash + + +Separator +XmSeparatorGadget +dividing line between window panes + + + + + + +Classes +PanedWindow inherits behavior and resources from the +Core, Composite, Constraint, and XmManager classes. + +The class pointer is xmPanedWindowWidgetClass. + +The class name is XmPanedWindow. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmPanedWindow Resource Set + + +Name +Class +Type +Default +Access + + +XmNmarginHeight +XmCMarginHeight +Dimension +3 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +3 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmVERTICAL +CSG + + +XmNrefigureMode +XmCBoolean +Boolean +True +CSG + + +XmNsashHeight +XmCSashHeight +Dimension +10 +CSG + + +XmNsashIndent +XmCSashIndent +Position +-10 +CSG + + +XmNsashShadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNsashWidth +XmCSashWidth +Dimension +10 +CSG + + +XmNseparatorOn +XmCSeparatorOn +Boolean +True +CSG + + +XmNspacing +XmCSpacing +Dimension +8 +CSG + + + + + + +XmNmarginHeight + +Specifies the distance between the top and bottom edges of the PanedWindow +and its children. + + + + +XmNmarginWidth + +Specifies the distance between the left and right edges of the PanedWindow +and its children. + + + + +XmNorientation + +Specifies the layout as either vertical (with the XmVERTICAL +value) or horizontal (with the XmHORIZONTAL value). In the +vertical layout, the children are laid out in a vertically tiled +format. In the horizontal layout, the children are laid out in a +horizontal layout, with the sash moveable along the horizontal axis. + + + + +XmNrefigureMode + +Determines whether the panes' positions are recomputed and repositioned +when programmatic changes are being made to the PanedWindow. +Setting this resource to True resets the children to their appropriate +positions. + + + + +XmNsashHeight + +Specifies the height of the sash. + + + + +XmNsashIndent + +Specifies the horizontal placement of the sash along each pane. A positive +value causes the sash to be offset from the near (left) side of the PanedWindow, +and a negative value causes the sash to be offset from the far (right) +side of the PanedWindow. If the offset is greater than the width of the +PanedWindow minus the width of the sash, the sash is placed flush +against the near side of the PanedWindow. + +Whether the placement actually corresponds to the left or right side of +the PanedWindow +depends on the XmNlayoutDirection +resource of the widget. + + + + +XmNsashShadowThickness + +Specifies the thickness of the shadows of the sashes. + + + + +XmNsashWidth + +Specifies the width of the sash. + + + + +XmNseparatorOn + +Determines whether a separator is created between each of the panes. +Setting this resource to True creates a Separator at the +midpoint between each of the panes. + + + + +XmNspacing + +Specifies the distance between each child pane. + + + + + + + + + + + +XmPanedWindow Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowResize +XmCBoolean +Boolean +False +CSG + + +XmNpaneMaximum +XmCPaneMaximum +Dimension +1000 +CSG + + +XmNpaneMinimum +XmCPaneMinimum +Dimension +1 +CSG + + +XmNpositionIndex +XmCPositionIndex +short +XmLAST_POSITION +CSG + + +XmNskipAdjust +XmCBoolean +Boolean +False +CSG + + + + + + + +XmNallowResize + +Allows an application to specify whether the PanedWindow +should allow a pane to request to be resized. This flag has an +effect only after the PanedWindow and its children have been realized. +If this flag is set to True, the PanedWindow tries to honor requests +to alter the height of the pane. If False, it always denies pane +requests to resize. + + + + +XmNpaneMaximum + +Allows an application to specify the maximum size to which a pane +may be resized. This value must be greater than the specified minimum. + + + + +XmNpaneMinimum + +Allows an application to specify the minimum size to which a pane +may be resized. This value must be greater than 0 (zero). + + + + +XmNpositionIndex + +Specifies the position of the widget in its parent's list of +children (the list of pane children, not including sashes). The value +is an integer that is no less than 0 (zero) and no greater than +the number of children in the list at the time the value is +specified. A value of 0 means that the child is placed at the +beginning of the list. The value can also be specified as +XmLAST_POSITION (the default), which means that the child +is placed at the end of the list. Any other value is ignored. +XtGetValues returns the position of the widget in its parent's +child list at the time of the call to XtGetValues. + +When a widget is inserted into its parent's child list, the positions +of any existing children that are greater than or equal to the +specified widget's XmNpositionIndex are increased by 1. +The effect of a call to XtSetValues for XmNpositionIndex +is to remove the specified widget from its parent's child list, decrease +by one the positions of any existing children that are greater than +the specified widget's former position in the list, and then insert +the specified widget into its parent's child list as described in the +preceding sentence. + + + + +XmNskipAdjust + +When set to True, this Boolean resource allows an application to specify +that the PanedWindow should not automatically resize this pane. + + + + + + +Inherited Resources +PanedWindow inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +default procedure +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + + + +Translations +XmPanedWindow inherits translations from XmManager. + +The translations for sashes within the PanedWindow are +described in the following table. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +≈c ≈s ≈m ≈a Btn1Down: + +SashAction(Start) + + + + +≈c ≈s ≈m ≈a Btn1Motion: + +SashAction(Move) + + + + +≈c ≈s ≈m ≈a Btn1Up: + +SashAction(Commit) + + + + +≈c ≈s ≈m ≈a Btn2Down: + +SashAction(Start) + + + + +≈c ≈s ≈m ≈a Btn2Motion: + +SashAction(Move) + + + + +≈c ≈s ≈m ≈a Btn2Up: + +SashAction(Commit) + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfHelp: + +Help() + + + + +:c KeyosfUp: + +SashAction(Key,LargeIncr,Up) + + + + +:KeyosfUp: + +SashAction(Key,DefaultIncr,Up) + + + + +:c KeyosfRight: + +SashAction(Key,LargeIncr,Right) + + + + +:KeyosfRight: + +SashAction(Key,DefaultIncr,Right) + + + + +:c KeyosfDown: + +SashAction(Key,LargeIncr,Down) + + + + +:KeyosfDown: + +SashAction(Key,DefaultIncr,Down) + + + + +:c KeyosfLeft: + +SashAction(Key,LargeIncr,Left) + + + + +:KeyosfLeft: + +SashAction(Key,DefaultIncr,Left) + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +s ≈m ≈a KeyTab: + +PrevTabGroup() + + + + +≈m ≈a KeyTab: + +NextTabGroup() + + + + + + + +Action Routines +The XmPanedWindow action routines are + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +NextTabGroup(): + +Moves the keyboard focus to the next tab group. +By default, each pane and sash is a tab group. + + + + +PrevTabGroup(): + +Moves the keyboard focus to the previous tab group. +By default, each pane and sash is a tab group. + + + + +SashAction(action) or SashAction(Key,&npzwc;increment,&npzwc;direction): + +The Start action activates the interactive placement of the pane's borders. +The Move action causes the sash to track the position of the pointer. +If one of the panes reaches its minimum or maximum size, adjustment +continues with the next adjustable pane. +The Commit action ends sash motion. + +When sash action is caused by a keyboard event, the sash with the keyboard +focus is moved according to the increment and direction +specified. DefaultIncr adjusts the sash by one line. +LargeIncr adjusts the sash by one view region. The direction +is specified as either +Up, Down, Left, or Right. + +Note that the SashAction action routine is not a direct action routine +of the XmPanedWindow, but rather an action of the Sash control created +by the XmPanedWindow. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +FocusIn: + +Moves the keyboard focus to the sash and highlights it + + + + +FocusOut: + +Unsets the keyboard focus in the sash and unhighlights it + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, +&cdeman.Core;, &cdeman.XmCreatePanedWindow;, and &cdeman.XmManager;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapA.sgm new file mode 100644 index 00000000..e5cf0567 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapA.sgm @@ -0,0 +1,378 @@ + + + + + + + + + + + +XmParseMapping +library call + + +XmParseMapping +Data type for a compound string parse mapping + +XmParseMapping + +data types +XmParseMapping + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmParseMapping is an opaque data type for a parse mapping used by +XmStringParseText to create a compound string. +A parse mapping contains a pattern to be matched in text being parsed to +create a compound string. +It also contains a compound string, or a function to be invoked to +provide a compound string, to be included in the compound string being +created whenever the pattern is matched. + +An application uses a resource-style interface to specify components for +an XmParseMapping. +XmParseMappingCreate creates a parse mapping, using a +resource-style argument list. +XmParseMappingGetValues and XmParseMappingSetValues retrieve +and set the components of a parse mapping. +XmParseMappingFree recovers memory used by a parse mapping. +XmParseTable is an array of XmParseMapping objects. + +The XmNinvokeParseProc resource is a function of type +XmParseProc, which is defined as follows: + +XmIncludeStatus (*XmParseProc) (text_in_out, text_end, type, tag, entry, pattern_length, +str_include, call_data) + XtPointer *text_in_out; + XtPointer text_end; + XmTextType type; + XmStringTag tag; + XmParseMapping entry; + int pattern_length; + XmString *str_include; + XtPointer call_data; +A parse procedure provides an escape mechanism for arbitrarily complex +parsing. +This procedure is invoked when a pattern in the input text is matched +with a pattern in a parse mapping whose XmNincludeStatus is +XmINVOKE. + +The input text is a pointer to the first byte of the pattern that was +matched to trigger the call to the parse procedure. +The parse procedure consumes as many bytes of the input string as it +needs and sets the input text pointer to the following byte. +It returns a compound string to be included in the compound string being +constructed, and it also returns an XmIncludeStatus indicating how +the returned compound string should be handled. +If the parse procedure does not set the input text pointer ahead by at +least one byte, the parsing routine continues trying to match the input +text with the patterns in the remaining parse mappings in the parse +table. +Otherwise, the parsing routine begins with the new input text pointer +and tries to match the input text with patterns in the parse mappings +starting at the beginning of the parse table. + + + +text_in_out + +Specifies the text being parsed. +The value is a pointer to the first byte of text matching the pattern +that triggered the call to the parse procedure. +When the parse procedure returns, this argument is set to the position +in the text where parsing should resume—that is, to the byte +following the last character parsed by the parse procedure. + + + + +text_end + +Specifies a pointer to the end of the text_in_out string. +If text_end is NULL, the string is scanned until a NULL character +is found. +Otherwise, the string is scanned up to but not including the character +whose address is text_end. + + + + +type + +Specifies the type of text and the tag type. +If a locale tag should be created, type has a value of either +XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT. +If a charset should be created, type has a value of +XmCHARSET_TEXT. + + + + +tag + +Specifies the tag to be used in creating the result. +The type of string tag created (charset or locale) depends on the text +type and the passed in tag value. +If the tag value is NULL and if type indicates that a +charset string tag should be created, the string tag has the value +that is the result of mapping XmSTRING_DEFAULT_CHARSET. +If type indicates a locale string tag, the string tag has the +value _MOTIF_DEFAULT_LOCALE. + + + + +entry + +Specifies the parse mapping that triggered the call to the parse +procedure. + + + + +pattern_length + +Specifies the number of bytes in the input text, following +text_in_out, that constitute the matched pattern. + + + + +str_include + +Specifies a pointer to a compound string. +The parse procedure creates a compound string to be included in the +compound string being constructed. +The parse procedure then returns the compound string in this argument. + + + + +call_data + +Specifies data passed by the application to the parsing routine. + + + + +The parse procedure returns an XmIncludeStatus indicating how +str_include is to be included in the compound string being +constructed. +Following are the possible values: + + + +XmINSERT + +Concatenate the result to the compound string being constructed and +continue parsing. + + + + +XmTERMINATE + +Concatenate the result to the compound string being constructed and +terminate parsing. + + + + + +New Resources +The following table defines a set of resources used by the programmer +to specify data. +The codes in the access column indicate if the given resource can be set +at creation time (C), set by using XmParseMappingSetValues (S), +retrieved by using XmParseMappingGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmParseMapping Resource Set + + +Name +Class +Type +Default +Access + + +XmNclientData + +XtPointer +NULL +CSG + + +XmNincludeStatus + +XmIncludeStatus +XmINSERT +CSG + + +XmNinvokeParseProc + +XmParseProc +NULL +CSG + + +XmNpattern + +XtPointer +NULL +CSG + + +XmNpatternType + +XmTextType +XmCHARSET_TEXT +CSG + + +XmNsubstitute + +XmString +NULL +CSG + + + + + + +XmNclientData + +Specifies data to be used by the parse procedure. + + + + +XmNincludeStatus + +Specifies how the result of the mapping is to be included in the +compound string being constructed. +Unless the value is XmINVOKE, the result of the mapping is the +value of XmNsubstitute. +Following are the possible values for XmNincludeStatus: + + + +XmINSERT + +Concatenate the result to the compound string being constructed and +continue parsing. + + + + +XmINVOKE + +Invoke the XmNinvokeParseProc on the text being parsed and use the +returned compound string instead of XmNsubstitute as the result to +be inserted into the compound string being constructed. +The include status returned by the parse procedure (XmINSERT or +XmTERMINATE) determines how the returned compound string is +included. + + + + +XmTERMINATE + +Concatenate the result to the compound string being constructed and +terminate parsing. + + + + + + + +XmNinvokeParseProc + +Specifies the parse procedure to be invoked when XmNincludeStatus +is XmINVOKE. + + + + +XmNpattern + +Specifies a pattern to be matched in the text being parsed. +This is a maximum of one character. + + + + +XmNpatternType + +Specifies the type of the pattern that is the value of XmNpattern. +Following are the possible values: + + + +XmCHARSET_TEXT + + + +XmMULTIBYTE_TEXT + + + +XmWIDECHAR_TEXT + + + + + + +XmNsubstitute + +Specifies the compound string to be included in the compound string +being constructed when XmNincludeStatus is XmINSERT or +XmTERMINATE. + + + + + + + +RELATED +&cdeman.XmParseMappingCreate;, +&cdeman.XmParseMappingFree;, +&cdeman.XmParseMappingGetValues;, +&cdeman.XmParseMappingSetValues;, +&cdeman.XmParseTable;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapB.sgm new file mode 100644 index 00000000..37c8c442 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapB.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmParseMappingCreate +library call + + +XmParseMappingCreate +A compound string function to create a parse mapping + +XmParseMappingCreate + +compound string functions +XmParseMappingCreate + + + + + + + + + + + +#include <Xm/Xm.h> + +XmParseMapping XmParseMappingCreate + +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmParseMappingCreate creates a parse mapping for use in a parse +table. +This function allows the application to specify values for components of +the parse mapping using a resource-style argument list. + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of XmParseMapping and its associated +resources, see &cdeman.XmParseMapping;. + + + +RETURN +Returns the XmParseMapping object. +The function allocates space to hold the returned XmParseMapping object. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmParseMappingFree. + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseMappingFree;, +&cdeman.XmParseMappingGetValues;, +&cdeman.XmParseMappingSetValues;, +&cdeman.XmParseTable;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapC.sgm new file mode 100644 index 00000000..f96c8ff7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapC.sgm @@ -0,0 +1,67 @@ + + + + + + + + + + + +XmParseMappingFree +library call + + +XmParseMappingFree +A compound string function to free a parse mapping + +XmParseMappingFree + +compound string functions +XmParseMappingFree + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmParseMappingFree + +XmParseMapping parse_mapping + + + +DESCRIPTION +XmParseMappingFree recovers memory used by an +XmParseMapping. + + + +parse_mapping + +Specifies the parse mapping to be freed + + + + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseMappingCreate;, +&cdeman.XmParseMappingGetValues;, +&cdeman.XmParseMappingSetValues;, +&cdeman.XmParseTable;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapD.sgm new file mode 100644 index 00000000..a4a52c50 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapD.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmParseMappingGetValues +library call + + +XmParseMappingGetValues +A compound string function to retrieve attributes of a parse mapping + +XmParseMappingGetValues + +compound string functions +XmParseMappingGetValues + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmParseMappingGetValues + +XmParseMapping parse_mapping +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmParseMappingGetValues retrieves attributes of an +XmParseMapping object, using a resource-style argument list. +If the XmNsubstitute resource is in the arglist, the +function will allocate space to hold the returned XmString value. +The application is responsible for managing this allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of XmParseMapping and its associated +resources, see &cdeman.XmParseMapping;. + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseMappingCreate;, +&cdeman.XmParseMappingFree;, +&cdeman.XmParseMappingSetValues;, +&cdeman.XmParseTable;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapE.sgm new file mode 100644 index 00000000..1dd051e1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParMapE.sgm @@ -0,0 +1,80 @@ + + + + + + + + + + + +XmParseMappingSetValues +library call + + +XmParseMappingSetValues +A compound string function to set attributes of a parse mapping + +XmParseMappingSetValues + +compound string functions +XmParseMappingSetValues + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmParseMappingSetValues + +XmParseMapping parse_mapping +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmParseMappingSetValues specifies attributes of an +XmParseMapping object, using a resource-style argument list. + + + +arglist + +Specifies the argument list + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist) + + + + +For a complete definition of XmParseMapping and its associated +resources, see &cdeman.XmParseMapping;. + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseMappingCreate;, +&cdeman.XmParseMappingFree;, +&cdeman.XmParseMappingGetValues;, +&cdeman.XmParseTable;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabA.sgm new file mode 100644 index 00000000..661fc04d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabA.sgm @@ -0,0 +1,65 @@ + + + + + + + + + + + +XmParseTable +library call + + +XmParseTable +Data type for a compound string parse table + +XmParseTable + +data types +XmParseTable + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmParseTable is the data type for an array of parse mappings +(objects of type XmParseMapping). + +A parse table is used by some routines that parse and unparse compound +strings. +The table is an ordered list of parse mappings. +A parsing routine that uses a parse table scans the input text and +searches the parse mappings, in order, for one containing a pattern that +matches the input text. +The matching parse mapping supplies a compound string to be included in +the compound string under construction. + +An unparsing routine that uses a parse table searches the parse +mappings, in order, for one containing a compound string that matches +the input compound string. +The unparsing routine can then include the parse mapping's text pattern +in the output text under construction. + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseTableFree;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabB.sgm new file mode 100644 index 00000000..cfe36428 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ParTabB.sgm @@ -0,0 +1,71 @@ + + + + + + + + + + + +XmParseTableFree +library call + + +XmParseTableFree +A compound string function that recovers memory + +XmParseTableFree + +compound string functions +XmParseTableFree + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmParseTableFree + +XmParseTable parse_table +Cardinal count + + + +DESCRIPTION +XmParseTableFree recovers memory used by an XmParseTable +and its constituent XmParseMappings. + + + +parse_table + +Specifies the parse table to be freed + + + + +count + +Specifies the number of parse mappings in the parse table + + + + + + +RELATED +&cdeman.XmParseTable; and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Primitiv.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Primitiv.sgm new file mode 100644 index 00000000..7e3e9d97 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Primitiv.sgm @@ -0,0 +1,1499 @@ + + + + + + + + + + + +XmPrimitive +library call + + +XmPrimitive +The Primitive widget class + +XmPrimitive + +widget class +Primitive + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +Primitive is a widget class used as a supporting superclass +for other widget classes. It handles border drawing and highlighting, +traversal activation and deactivation, and various callback lists needed by +Primitive widgets. +Primitive and all its subclasses hold the XmQTcareParentVisual trait. + + +Data Transfer Behavior +Primitive has no widget class conversion or destination procedure. +Subclasses and the XmNconvertCallback procedures are responsible +for any conversion of selections. +Subclasses and the subclass XmNdestinationCallback procedures are +responsible for any data transfers to the widget. + + + +Classes +Primitive inherits behavior, resources, and traits from Core. + +The class pointer is xmPrimitiveWidgetClass. + +The class name is XmPrimitive. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + +XmNbottomShadowColor + +Specifies the color to use to draw the bottom and right sides of the +border shadow. +This color is used if the XmNtopShadowPixmap resource is +unspecified. + + + + +XmNbottomShadowPixmap + +Specifies the pixmap to use to draw the bottom and right sides of the +border shadow. + + + + +XmNconvertCallback + +Specifies a list of callbacks called when the widget is asked to convert +a selection. +The type of the structure whose address is passed to these callbacks is +XmConvertCallbackStruct. +The reason is XmCR_OK. + + + + +XmNforeground + +Specifies the foreground drawing color used by Primitive widgets. + + + + +XmNhelpCallback + +Specifies the list of callbacks that is called when the help key +is pressed. The reason sent by the callback is XmCR_HELP. + + + + +XmNhighlightColor + +Specifies the color of the highlighting rectangle. +This color is used if the highlight pixmap resource is +XmUNSPECIFIED_PIXMAP. + + + + +XmNhighlightOnEnter + +Specifies if the highlighting rectangle is drawn when the cursor moves +into the widget. +If the shell's focus policy is XmEXPLICIT, this resource is +ignored, and the widget is highlighted when it has the focus. +If the shell's focus policy is XmPOINTER and if this resource is +True, the highlighting rectangle is drawn when the cursor moves into +the widget. +If the shell's focus policy is XmPOINTER and if this resource is +False, the highlighting rectangle is not drawn when the the cursor moves +into the widget. +The default is False. + + + + +XmNhighlightPixmap + +Specifies the pixmap used to draw the highlighting rectangle. + + + + +XmNhighlightThickness + +Specifies the thickness of the highlighting rectangle. + + + + +XmNlayoutDirection + +Specifies the direction in which components of the primitive (including +strings) are laid out. The values are of type XmDirection. If +the widget's parent is a primitive or shell, the value is inherited from +the widget's parent. Otherwise, it is inherited from the closest +ancestor vendor or menu shell. Refer to the &cdeman.XmDirection; +reference page for the possible direction values. + + + + +XmNnavigationType + +Determines whether the widget is a tab group. + + + +XmNONE + +Indicates that the widget is not a tab group. + + + + +XmTAB_GROUP + +Indicates that the widget is a tab group, unless +the XmNnavigationType of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmSTICKY_TAB_GROUP + +Indicates that the widget is a tab group, even +if the XmNnavigationType of another widget in the hierarchy is +XmEXCLUSIVE_TAB_GROUP. + + + + +XmEXCLUSIVE_TAB_GROUP + +Indicates that the widget is a tab group and +that widgets in the hierarchy whose XmNnavigationType is +XmTAB_GROUP are not tab groups. + +When a parent widget has an XmNnavigationType of +XmEXCLUSIVE_TAB_GROUP, traversal of non-tab-group widgets within +the group is based on the order of those widgets in their parent's +XmNchildren list. + +When the XmNnavigationType of any widget in a hierarchy is +XmEXCLUSIVE_TAB_GROUP, traversal of tab groups in the hierarchy +proceeds to widgets in the order in which their XmNnavigationType +resources were specified as XmEXCLUSIVE_TAB_GROUP or +XmSTICKY_TAB_GROUP, whether by creating the widgets with that value, +by calling XtSetValues, or by calling XmAddTabGroup. + + + + + + + +XmNpopupHandlerCallback + +Allows the application to control which popup menu will be +automatically posted. The reason can either be XmCR_POST or +XmCR_REPOST: + + +XmCR_POST + +Indicates that this is a regular posting request. + + + + +XmCR_REPOST + +Indicates that the menu was just unposted and that this callback was +invoked on a replay. + + + + +This callback +uses the XmPopupHandlerCallbackStruct +structure to pass information. + + + + +XmNshadowThickness + +Specifies the size of the drawn border shadow. + + + + +XmNtopShadowColor + +Specifies the color to use to draw the top and left sides of the border +shadow. +This color is used if the XmNtopShadowPixmap resource is +unspecified. +If a default top shadow pixmap exists, it will need to be removed for +the XmNtopShadowColor to take effect. + + + + +XmNtopShadowPixmap + +Specifies the pixmap to use to draw the top and left sides of the border +shadow. +A Primitive top shadow pixmap is created in two situations. In either +of these situations, a default 50-foreground top shadow +pixmap is created. + + + +If the Primitive top shadow color is the same as the +Core background pixel color. + + + +If the depth of the screen is only one. + + + +For example, if a widget with the same top shadow and background color +is created, a default shadow pixmap is generated. Such a pixmap +needs to be removed for the XmNtopShadowColor resource to take +effect. + + + + +XmNtraversalOn + +Specifies if traversal is activated for this widget. In CascadeButton +and CascadeButtonGadget, this resource is forced to True unless the parent +is an OptionMenu. + + + + +XmNunitType + +Provides the basic support for resolution independence. +It defines the type of units a widget uses with sizing and +positioning resources. +If the widget's parent is a subclass of XmManager and if the +XmNunitType resource is not explicitly set, it defaults to the +unit type of the parent widget. +If the widget's parent is not a subclass of XmManager, the +resource has a default unit type of XmPIXELS. + +The unit type can also be specified in resource files, with the +following format: + + +<floating value><unit> + + +where: + + + +unit + +is <" ", pixels, inches, centimeters, millimeters, points, font units> + + + + +pixels + +is <pix, pixel, pixels> + + + + +inches + +is <in, inch, inches> + + + + +centimeter + +is <cm, centimeter, centimeters> + + + + +millimeters + +is <mm, millimeter, millimeters> + + + + +points + +is <pt, point, points> + + + + +font units + +is <fu, font_unit, font_units> + + + + +float + +is {"+"|"-"}{{<"0"-"9">*}.}<"0"-"9">* + +Note that the type Dimension must always be positive. + + + + +For example, + + +xmfonts*XmMainWindow.height: 10.4cm +*PostIn.width: 3inches + + +XmNunitType can have the following values: + + + +XmPIXELS + +All values provided to the widget are treated as normal +pixel values. + + + + +XmMILLIMETERS + +All values provided to the widget are treated as normal millimeter +values. + + + + +Xm100TH_MILLIMETERS + +All values provided to the widget are treated +as 1/100 of a millimeter. + + + + +XmCENTIMETERS + +All values provided to the widget are treated as normal centimeter +values. + + + + +XmINCHES + +All values provided to the widget are treated as normal inch +values. + + + + +Xm1000TH_INCHES + +All values provided to the widget are treated as +1/1000 of an inch. + + + + +XmPOINTS + +All values provided to the widget are treated as normal point +values. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +Xm100TH_POINTS + +All values provided to the widget are treated as +1/100 of a point. A point is a unit used in text processing +applications and is defined as 1/72 of an inch. + + + + +XmFONT_UNITS + +All values provided to the widget are treated as normal font +units. A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + +Xm100TH_FONT_UNITS + +All values provided to the widget are +treated as 1/100 of a font unit. +A font unit has horizontal and vertical components. +These are the values of the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + + + + + +XmNuserData + +Allows the application to attach any necessary specific data to the widget. +It is an internally unused resource. + + + + + + +Dynamic Color Defaults +The foreground, background, top shadow, bottom shadow, and +highlight color resources are dynamically defaulted. +If no color data is specified, the colors are +automatically generated. On a single-plane system, a black and white color +scheme is generated. Otherwise, four colors are +generated, which display the correct shading for the 3-D visuals. +If the background is the only color specified for a widget, the top +shadow and bottom shadow colors are generated to give the 3-D appearance. +Foreground and highlight colors are generated to provide sufficient +contrast with the background color. + +Colors are generated only at creation. Resetting the background through +XtSetValues does not regenerate the other colors. +XmChangeColor can be used to recalculate all associated colors +based on a new background color. + + + +Inherited Resources +Primitive inherits behavior and resources from the +superclass described in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback for +XmNhelpCallback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + + +reason + +Indicates why the callback was invoked. +For this callback, reason is set to XmCR_HELP. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +A pointer to the following callback structure is passed to the +XmNconvertCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + Atom target; + XtPointer source_data; + XtPointer location_data; + int flags; + XtPointer parm; + int parm_format; + unsigned long parm_length; + Atom parm_type; + int status; + XtPointer value; + Atom type; + int format; + unsigned long length; +} XmConvertCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which conversion is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, +and _MOTIF_DROP. + + + + +target + +Indicates the conversion target. + + + + +source_data + +Contains information about the selection source. +When the selection is _MOTIF_DROP, source_data is the +DragContext. +Otherwise, it is NULL. + + + + +location_data + +Contains information about the location of data to be converted. +If the value is NULL, the data to be transferred consists of the +widget's current selection. +Otherwise, the type and interpretation of the value are specific to the +widget class. + + + + +flags + +Indicates the status of the conversion. Following are the possible +values: + + + +XmCONVERTING_NONE + +This flag is currently unused. + + + + +XmCONVERTING_PARTIAL + +The target widget was able to be converted, but some data was lost. + + + + +XmCONVERTING_SAME + +The conversion target is the source of the data to be transferred. + + + + +XmCONVERTING_TRANSACT + +This flag is currently unused. + + + + + + + +parm + +Contains parameter data for this target. +If no parameter data exists, the value is NULL. + +When selection is CLIPBOARD and target is +_MOTIF_CLIPBOARD_TARGETS or +_MOTIF_DEFERRED_CLIPBOARD_TARGETS, the value is the requested +operation (XmCOPY, XmMOVE, or XmLINK). + + + + +parm_format + +Specifies whether the data in parm should be viewed +as a list of char, short, or long quantities. +Possible values are 0 (when parm is NULL), +8 (when the data in parm should be viewed as a list of chars), +16 (when the data in parm should be viewed as a list of shorts), +or 32 (when the data in parm should be viewed as a list of longs). +Note that parm_format symbolizes a data type, not the number of bits +in each list element. +For example, on some machines, a parm_format of 32 means that +the data in parm should be viewed as a list of 64-bit quantities, +not 32-bit quantities. + + + + +parm_length + +Specifies the number of elements of data in parm, where each +element has the size specified by parm_format. +When parm is NULL, the value is 0. + + + + +parm_type + +Specifies the parameter type of parm. + + + + +status + +An IN/OUT member that specifies the status of the conversion. +The initial value is XmCONVERT_DEFAULT. +The callback procedure can set this member to one of the following +values: + + + +XmCONVERT_DEFAULT + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it +overwrites the data provided by the callback procedures in the value +member. + + + + +XmCONVERT_MERGE + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it appends +its data to the data provided by the callback procedures in the +value member. +This value is intended for use with targets that result in lists of +data, such as TARGETS. + + + + +XmCONVERT_DONE + +This value means that the callback procedure has successfully finished +the conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + +XmCONVERT_REFUSE + +This value means that the callback procedure has terminated the +conversion process without completing the requested conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + + + + +value + +An IN/OUT parameter that contains any data that the callback procedure +produces as a result of the conversion. +The initial value is NULL. +If the callback procedure sets this member, it must ensure that the +type, format, and length members correspond +to the data in value. +The callback procedure is responsible for allocating memory when it sets +this member. +The toolkit frees this memory when it is no longer needed. + + + + +type + +An IN/OUT parameter that indicates the type of the data in the +value member. +The initial value is INTEGER. + + + + +format + +An IN/OUT parameter that specifies whether the data in value should +be viewed as a list of char, short, or long quantities. +The initial value is 8. +The callback procedure can set this member to 8 (for a list of char), +16 (for a list of short), or 32 (for a list of long). + + + + +length + +An IN/OUT member that specifies the number of elements of data in +value, where each element has the size symbolized by format. +The initial value is 0. + + + + +A pointer to the following structure is passed to each callback for +XmNpopupHandlerCallback: + +typedef struct +{ + int reason; + XEvent * xevent; + Widget menuToPost; + Boolean postIt; + Widget target; +} XmPopupHandlerCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +xevent + +Points to the XEvent that triggered the handler. + + + + +menuToPost + +Specifies the popup menu that the menu system believes should be +posted. The application may modify this field. + + + + +postIt + +Indicates whether the posting process should continue. The +application may modify this field. + + + + +target + +Specifies the most specific widget or gadget that the menu sytem found +from the event that matches the event. + + + + + + + + + + + + + + + + +Translations +The XmPrimitive translations are listed below. + +Note that for buttons in menus, altering translations in #override +or #augment mode is undefined. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfBeginLine: + +PrimitiveTraverseHome() + + + + +:KeyosfUp: + +PrimitiveTraverseUp() + + + + +:KeyosfDown: + +PrimitiveTraverseDown() + + + + +:KeyosfLeft: + +PrimitiveTraverseLeft() + + + + +:KeyosfRight: + +PrimitiveTraverseRight() + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +s ≈m ≈a KeyTab: + +PrimitivePrevTabGroup() + + + + +≈m ≈a KeyTab: + +PrimitiveNextTabGroup() + + + + +KeyosfHelp: + +PrimitiveHelp() + + + + + + + +Action Routines +The XmPrimitive action routines are + + + +PrimitiveHelp(): + +Calls the callbacks for XmNhelpCallback if any exist. If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +PrimitiveNextTabGroup(): + +This action depends on the value of the Display resource +XmNenableButtonTab. When XmNenableButtonTab is False +(default), this action traverses to the first item in the next tab +group. If the current tab group is the last entry in the tab group +list, it wraps to the beginning of the tab group list. + +When XmNenableButtonTab is True, this action moves to the next +item within the current tab group, unless it is the last item in the +tab group. When the item is the last in the group, the action +traverses to the first item in the next tab group. The +XmNenableButtonTab behavior applies only to PushButton, ArrowButton, +and DrawnArrow. + + + + +PrimitiveParentActivate(): + +If the parent is a manager, +passes the KActivate event received by the widget +to the parent. + + + + +PrimitiveParentCancel(): + +If the parent is a manager, +passes the KCancel event received by the widget +to the parent. + + + + +PrimitivePrevTabGroup(): + +This action depends on the value of the Display resource +XmNenableButtonTab. When XmNenableButtonTab is False +(default), this action traverses to the first item in the previous tab +group. If the beginning of the tab group list is reached, it wraps to +the end of the tab group list. + +When XmNenableButtonTab is True, this action moves to the +previous item within the current tab group unless it is the first item +in the tab group. When the item is the first in the group, the action +traverses to the first item in the previous tab group. The +XmNenableButtonTab behavior applies only PushButton, ArrowButton, and +DrawnButton. + + + + +PrimitiveTraverseDown(): + +Traverses to the next item below the current widget in the current tab +group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +PrimitiveTraverseHome(): + +Traverses to the first widget or gadget in the current tab group. + + + + +PrimitiveTraverseLeft(): + +Traverses to the next item to the left of the current widget in the +current tab group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +PrimitiveTraverseNext(): + +Traverses to the next item in the current tab group, wrapping if +necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +PrimitiveTraversePrev(): + +Traverses to the previous item in the current tab group, wrapping if +necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +PrimitiveTraverseRight(): + +Traverses to the next item to the right of the current gadget in the +current tab group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + +PrimitiveTraverseUp(): + +Traverses to the next item above the current gadget in the current tab +group, wrapping if necessary. +The wrapping direction depends on the layout direction of the +widget tab group. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +FocusIn: + +If the shell's keyboard focus policy is XmEXPLICIT, highlights the +widget and gives it the focus + + + + +FocusOut: + +If the shell's keyboard focus policy is XmEXPLICIT, unhighlights +the widget and removes the focus + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmDirection;, +&cdeman.XmChangeColor;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ProcessT.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ProcessT.sgm new file mode 100644 index 00000000..0c3805df --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ProcessT.sgm @@ -0,0 +1,430 @@ + + + + + + + + + + + +XmProcessTraversal +library call + + +XmProcessTraversal +A function that determines which component receives keyboard events when a widget has the focus + +XmProcessTraversal + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmProcessTraversal + +Widget widget +XmTraversalDirection direction + + + +DESCRIPTION +XmProcessTraversal determines which component of a hierarchy +receives keyboard events when the hierarchy that contains the given +widget has keyboard focus. + +XmProcessTraversal changes focus only when the keyboard focus +policy of the widget hierarchy is explicit. +If the XmNkeyboardFocusPolicy of the nearest shell ancestor of the +given widget is not XmEXPLICIT, XmProcessTraversal +returns False without making any focus changes. + + + +widget + +Specifies the widget ID of the widget whose hierarchy is to be +traversed + + + + +direction + +Specifies the direction of traversal + + + + + +DEFINITIONS +In order to be eligible to receive keyboard focus when the shell's +XmNkeyboardFocusPolicy is XmEXPLICIT, a widget or gadget +must meet the following conditions: + + + +The widget and its ancestors are not in the process of being destroyed. + + + +The widget and its ancestors are sensitive. +A widget is sensitive when its XmNsensitive and +XmNancestorSensitive resources are both True. + + + +The XmNtraversalOn resource for the widget and its ancestors is +True. + + + +The widget is viewable. +This means that the widget and its ancestors are managed, realized, and +(except for gadgets) mapped. +Furthermore, in general, some part of the widget's rectangular area must +be unobscured by the widget's ancestors. If an application unmaps a +widget that has its XmNmappedWhenManaged resource set to True, the +result is undefined. + +In a ScrolledWindow with an XmNscrollingPolicy of +XmAUTOMATIC, a widget that is obscured because it is not within +the clip window may be able to receive focus if some part of the widget +is within the work area and if an XmNtraverseObscuredCallback +routine can make the widget at least partially visible by scrolling the +window. + + + +In general only primitives, gadgets, and Drawing Area are eligible to +receive focus. +Most managers cannot receive focus even if they meet all these +conditions. + +The direction argument identifies the kind of traversal action to +take. +The descriptions of these actions below refer to traversable +non-tab-group widgets and traversable tab groups. + + + +A traversable non-tab-group widget is a widget that is not a tab group +and that meets all the conditions for receiving focus described above. + + + +A traversable tab group widget is a tab group widget that meets the same +conditions, except that a manager that is a tab group and meets the +other conditions is also eligible for traversal as long as it contains a +descendant that can receive focus. + + + +A tab group is a widget whose XmNnavigationType is: + + + +XmTAB_GROUP or XmSTICKY_TAB_GROUP, if the hierarchy (up to +the nearest shell ancestor) that contains the widget has no widget whose +XmNnavigationType is XmEXCLUSIVE_TAB_GROUP + + + +XmEXCLUSIVE_TAB_GROUP or XmSTICKY_TAB_GROUP, if the +hierarchy (up to the nearest shell ancestor) that contains the widget +has any widget whose XmNnavigationType is +XmEXCLUSIVE_TAB_GROUP + + + + + +TRAVERSAL ACTIONS +The hierarchy to be traversed is that containing the widget +argument. +This hierarchy is traversed only up to the nearest shell; +XmProcessTraversal does not move focus from one shell to another. +If the shell containing widget does not currently have the focus, +any change that XmProcessTraversal makes to the element with focus +within that shell does not take effect until the next time the shell +receives focus. + +XmProcessTraversal begins the traversal action from the widget in +the hierarchy that currently has keyboard focus or that last had focus +when the user traversed away from the shell hierarchy. + +The value of the direction argument determines which of three +kinds of traversal action to take: + + + +Traversal to a non-tab-group widget. +This kind of traversal is possible only when the widget that currently +has focus is not a tab group; otherwise, XmProcessTraversal +returns False for these actions. + +These actions do not move focus from one tab group to another. +The actions first determine the containing tab group. +This is the tab group containing the widget that currently has focus. +The actions traverse only to a non-tab-group widget within the +containing tab group. + +A non-tab-group widget is eligible for this kind of traversal if the +widget is traversable and has no tab group ancestors up to the +containing tab group. +If the tab group contains no traversable non-tab-group widgets, +XmProcessTraversal returns False. + +Following are the possible values of the direction argument. +Note that when actions wrap, wrapping occurs in the traversal +direction. The following describes what happens in a left +to right environment: + + + +XmTRAVERSE_RIGHT—If the XmNnavigationType of the +containing tab group is not XmEXCLUSIVE_TAB_GROUP, focus moves to +the next traversable non-tab-group widget to the right of the widget +that currently has focus. +In a left to right environment, at the right side of the tab group +this action wraps to the +non-tab-group widget at the left side and next toward the bottom. +At the rightmost widget in the bottom row of the tab group this action +wraps to the +non-tab-group widget at the leftmost widget in the upper row. + +In a right to left environment, at the right side of the tab group, +this action wraps to the non-tab-group widget at the left side and +next toward the top. At the rightmost widget in the upper row of the +tab group this action wraps to the non-tab-group widget at the +leftmost widget in the bottom row. + +If the XmNnavigationType of the containing tab group is +XmEXCLUSIVE_TAB_GROUP, focus moves to the next traversable +non-tab-group widget in the tab group, proceeding in the order in which +the widgets appear in their parents' XmNchildren lists. +After the last widget in the tab group, this action wraps to the first +non-tab-group widget. + + + +XmTRAVERSE_LEFT—If the XmNnavigationType of the +containing tab group is not XmEXCLUSIVE_TAB_GROUP, focus moves to +the next traversable non-tab-group widget to the left of the widget that +currently has focus. +In a left to right environment, at the left side of the tab group this +action wraps to the non-tab-group +widget at the right side and next toward the top. +At the leftmost widget in the upper row of the tab group this action +wraps to the non-tab-group widget at the rightmost widget in the +bottom row. + +In a right to left environment, at the left side of the tab group this +action wraps to the non-tab-group widget at the right side and next +toward the bottom. At the leftmost widget in the bottom row of the +tab group this +action wraps to the non-tab-group widget at the rightmost widget in +the upper row. + +If the XmNnavigationType of the containing tab group is +XmEXCLUSIVE_TAB_GROUP, focus moves to the previous traversable +non-tab-group widget in the tab group, proceeding in the reverse order +in which the widgets appear in their parents' XmNchildren lists. +After the first widget in the tab group, this action wraps to the last +non-tab-group widget. + + + +XmTRAVERSE_DOWN—If the XmNnavigationType of the +containing tab group is not XmEXCLUSIVE_TAB_GROUP, focus moves to +the next traversable non-tab-group widget below the widget that +currently has focus. +In a left to right environment, at the bottom of the tab group this +action wraps to the non-tab-group +widget at the top and next toward the right. +At the bottom widget in the rightmost column of the tab group this action +wraps to the +non-tab-group widget at the top widget in the leftmost column. + +In a right to left environment, at the bottom of the tab group this +action wraps to the non-tab-group widget at the top and next toward +the left. At the bottom widget of the leftmost widget of the tab +group this action wraps +to the non-tab-group widget at the top widget of the rightmost column. + +If the XmNnavigationType of the containing tab group is +XmEXCLUSIVE_TAB_GROUP, focus moves to the next traversable +non-tab-group widget in the tab group, proceeding in the order in which +the widgets appear in their parents' XmNchildren lists. +After the last widget in the tab group, this action wraps to the first +non-tab-group widget. + + + +XmTRAVERSE_UP—If the XmNnavigationType of the containing +tab group is not XmEXCLUSIVE_TAB_GROUP, focus moves to the next +traversable non-tab-group widget above the widget that currently has +focus. +In a left to right environment, at the top of the tab group this +action wraps to the non-tab-group +widget at the bottom and next toward the left. +At the top widget of the leftmost column of the tab group this action +wraps to the +non-tab-group widget at the bottom widget of the rightmost column. + +In a right to left environment, at the top of the tab group this +action wraps to the non-tab-group widget at the bottom and next toward +the right. At the top widget of the right most column of the tab +group this action +wraps to the non-tab-group widget at the bottom widget of the leftmost +column. + +If the XmNnavigationType of the containing tab group is +XmEXCLUSIVE_TAB_GROUP, focus moves to the previous traversable +non-tab-group widget in the tab group, proceeding in the reverse order +in which the widgets appear in their parents' XmNchildren lists. +After the first widget in the tab group, this action wraps to the last +non-tab-group widget. + + + +XmTRAVERSE_NEXT—Focus moves to the next traversable +non-tab-group widget in the tab group, proceeding in the order in which +the widgets appear in their parents' XmNchildren lists. +After the last widget in the tab group, this action wraps to the first +non-tab-group widget. + + + +XmTRAVERSE_PREV—Focus moves to the previous traversable +non-tab-group widget in the tab group, proceeding in the reverse order +in which the widgets appear in their parents' XmNchildren lists. +After the first widget in the tab group, this action wraps to the last +non-tab-group widget. + + + +XmTRAVERSE_HOME—If the XmNnavigationType of the containing +tab group is not XmEXCLUSIVE_TAB_GROUP, focus moves to the first +traversable non-tab-group widget at the initial focus of the tab +group. + +If the XmNnavigationType of the containing tab group is +XmEXCLUSIVE_TAB_GROUP, focus moves to the first traversable +non-tab-group widget in the tab group, according to the order in which +the widgets appear in their parents' XmNchildren lists. + + + + + +Traversal to a tab group. +These actions first determine the current widget hierarchy and the +containing tab group. +The current widget hierarchy is the widget hierarchy whose root is the +nearest shell ancestor of the widget that currently has focus. +The containing tab group is is the tab group containing the widget that +currently has focus. +If the current widget hierarchy contains no traversable tab groups, +XmProcessTraversal returns False. + +Following are the possible values of the direction argument. If +any tab group in the current widget hierarchy has an +XmNnavigationType of XmEXCLUSIVE_TAB_GROUP, traversal of +tab groups in the hierarchy proceeds to widgets in the order in which +their XmNnavigationType resources were specified as +XmEXCLUSIVE_TAB_GROUP or XmSTICKY_TAB_GROUP.: + + + +XmTRAVERSE_NEXT_TAB_GROUP—Finds the hierarchy that contains +widget, +finds the active tab group (if any), and makes the next tab group the +active tab group in the hierarchy. + + + +XmTRAVERSE_PREV_TAB_GROUP—Finds the hierarchy that contains +widget, +finds the active tab group (if any), and makes the previous tab group the +active tab group in the hierarchy. + + + + + +Traversal to any widget. +In this case the widget argument is the widget to which +XmProcessTraversal tries to give focus. +If the widget is not traversable, XmProcessTraversal returns +False. + +Following are the possible values of the direction argument: + + + +XmTRAVERSE_CURRENT—Finds the hierarchy and the tab group that +contain widget. +If this tab group is not the active tab group, this action +makes it the active tab group. +If widget is an item in the active tab group, this action +makes it the active item. +If widget is the active tab group, this action +makes the first traversable +item in the tab group the active item. + + + + + + + +CAUTIONS +Using XmProcessTraversal to traverse to MenuBars, +Pulldown menu panes, or Popup menu panes is not supported. + +XmProcessTraversal cannot be called recursively. +In particular, an application cannot call this routine from an +XmNfocusCallback or XmNlosingFocusCallback procedure. + + + + +RETURN +Returns True if the traversal action succeeded. +Returns False if the XmNkeyboardFocusPolicy of the nearest shell +ancestor of widget is not XmEXPLICIT, if the traversal +action finds no traversable widget to receive focus, or if the call to +the routine has invalid arguments. + + + +RELATED +&cdeman.XmGetVisibility; and +&cdeman.XmIsTraversable;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtPopup.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtPopup.sgm new file mode 100644 index 00000000..630586ae --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtPopup.sgm @@ -0,0 +1,144 @@ + + + + + + + + + + +XmPrintPopupPDM +library call + + +XmPrintPopupPDM +Send a notification for the PDM to be popped up + + + + +#include <Xm/Print.h> + +XtEnum XmPrintPopupPDM +Widgetprint_shell +Widgetvideo_transient_for + + + +DESCRIPTION +A convenience function that sends a notification to start a +Print Dialog Manager on behalf of the application, +XmPrintPopupPDM +hides the details of the X selection +mechanism used to notify the PDM that a new dialog must be popped up for this application. + +XmPrintPopupPDM sends a selection request +to either the print display of the +print shell, or the video display of the +transient_for video widget (depending on +the environment variable XPDMDISPLAY, +which can only takes the value "print" or "video"), +asking for the PDM windows to be popped up on behalf +of the app. + +Return right away with status of +XmPDM_NOTIFY_FAIL +(e.g. if the function couldn't malloc +memory for the selection value, or if +XPDMDISPLAY +is not "print" or "video") or with +XmPDM_NOTIFY_SUCCESS +, which only means a "message" was sent out to the +PDM specified by +XPDMSELECTION +, not that it's already up on the screen yet. + +In order to know if the PDM is up, or not running, +the application must register a +XmNpdmNotificationCallback +with the Print Shell. + +XmPrintPopupPDM puts up an InputOnly +window on top of the dialog, so that +the end user doesn't use the print setup dialog while the PDM is trying to +come up. This window is automatically removed when the shell is +about to call the callback for the first time. + + + +print_shell + +The Print Shell used for this print job and context. + + + + +video_transient_for + +The video widget dealing with application print setup. + + + + + + +RETURN VALUE +Returns +XmPDM_NOTIFY_SUCCESS if the function +was able to send the notification out to the PDM process, +XmPDM_NOTIFY_FAIL otherwise. + + + +ERRORS/WARNINGS +Not applicable. + + + +EXAMPLES +Example of callback from a Print set up dialog box "Setup..." button: + + +PrintSetupCallback(print_dialog...) +/*-------------*/ +{ + if (XmPrintPopupPDM (pshell, XtParent(print_dialog)) != + XmPDM_NOTIFY_SUCCESS) { + /* some error dialog */ + } +} + +Example of XmNpdmNotificationCallback from a Print Shell: + + +pdmNotifyCB(print_shell...) +{ + XmPrintShellCallBackStruct * pr_cb = ... + + switch (pr_cb->reason) { + case XmCR_PDM_NONE: + /* no PDM available */ + PostErrorDialog(...); + break; + case XmCR_PDM_VXAUTH: + /* PDM is not authorized ... */ + PostErrorDialog(...); + break; + case XmCR_PDM_UP: the PDM is up and running + /* everything is fine */ + break; + default: /* other cases */ + } +} + + + +SEE ALSO +&cdeman.XmPrintSetup;, +&cdeman.XmPrintShell;, +&cdeman.XmRedisplayWidget;, +&cdeman.XmPrintToFile; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtSetup.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtSetup.sgm new file mode 100644 index 00000000..bae19dbf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtSetup.sgm @@ -0,0 +1,155 @@ + + + + + + + + + + +XmPrintSetup +library call + + +XmPrintSetup + +setup and create a Print Shell widget + + + + +#include <Xm/Print.h> + +Widget XmPrintSetup +Widget video_widget +Screen *print_screen +String print_shell_name +ArgList args +Cardinal num_args + + + +DESCRIPTION +A function that does the appropriate setting and creates a realized +XmPrintShell that it returns to the caller. This +function hides the details of the Xt to set up a valid print shell +heirarchy for the application. It is also meant +to encourage consistency in the way applications root their print widget +hierarchy. + + +print_screen must belong to a Display connection that +has already been initialized with Xt. + +The video_widget +is used to get at the application context, application name +and class, and argc/argv stored on the +applicationShell that roots this widget. If +no applicationShell is found, NULL argv/argc are used. + +XmPrintSetup then creates an unrealized ApplicationShell +with the same name and class as the one given by the video +display, on the print display and on the print screen specified. + +An XmPrintShell +is then created as a child of this toplevel shell, using +XtCreatePopupShell, with the name +print_shell_name, and using the +args +provided. It then realizes and maps the print shell, using +XtPopup with XtGrabNone. + +This way, application resource files and users can specify +print specific attributes using the following syntax +(if print_shell_name is "Print"): + + +Dtpad.Print*textFontList: somefont +*Print*background:white +*Print*highlightThickness:0 + + + +video_widget + +A video widget to fetch app video data from. + + + + +print_screen + +A print screen on the print display - specifies the screen onto which the new +shell is created. + + + + +print_shell_name + +Specifies the name of the XmPrintShell created on the X Print server. + + + + +args + +Specifies the argument list from which to get the resources for the XmPrintShell. + + + + +num_args + +Specifies the number of arguments in the argument list. + + + + + + +RETURN VALUE +The id the XmPrintShell widget created on the +X Print Server connection, or NULL if an error has occured. + + + +ERRORS/WARNINGS +None. + + + +EXAMPLES +From the OK callback and the +SetUp callback of the primary print dialog widget: + + +static void +printOKCB(Widget, XtPointer call_data, XtPointer client_data) +{ + AppPrint *p = (AppPrint *) client_data; + DtPrintSetupCallbackStruct *pbs = + (XmPrintCallbackStruct *) call_data; + + /* connect if not already done. + the print dialog callback always provides valid + printer name, print display and screen + already initialized: XpInitContext called */ + */ + p->print_shell = XmPrintSetup (widget, pbs->print_screen, + "Print", NULL, 0); + + ... +} + + + +SEE ALSO +&cdeman.XmPrintShell;, +&cdeman.XmRedisplayWidget;, +&cdeman.XmPrintToFile;, +&cdeman.XmPrintPopupPDM; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtShell.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtShell.sgm new file mode 100644 index 00000000..b6520b6b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtShell.sgm @@ -0,0 +1,448 @@ + + + + + + + + + + +XmPrintShell +library call + + +XmPrintShell + +a shell widget class used for printing in Motif + + + + +#include <Xm/Print.h> + +Boolean XmIsPrintShell +Widget + + + + +DESCRIPTION +The +XmPrintShell +provides the Motif application programmer +with an Xt widget oriented API to some of the X Print +resources and a callback to drive the pagination. + +The +XmPrintShell +provides a simple callback to handle the +pagination logic, and a set of resources to get and set +common printer attributes. + +If not created on an +XPrint +connection, +XmPrintShell +behaves +as a regular applicationShell. + +The +XmPrintShell +also initializes the Xp extension event +handling mechanism, by registering an extension selector +that calls +XpSelectInput +and event dispatcher for print +and attributes Xp events, so applications can use +XtInsertEventTypeHandler +to register their own handler +with the Xp events. + + +Arguments +No XmCreate function is provided, since this is a toplevel +shell, most likely created thru some Xt +shell creation routine or XmPrintSetup. + + + +Classes +XmPrintShell is a subclass of +ApplicationShell; it inherits +behavior, resources and traits from all its superclasses. +The class pointer is XmPrintShellWidgetClass. + + + +New Resources + + + + + + + + + +XmPrintShell Resource Set + + +Name +Class +Type +Default +Access + + +XmNstartJobCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNendJobCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNpageSetupCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNminX +XmCMinX +Dimension +dynamic +G + + +XmNminY +XmCMinY +Dimension +dynamic +G + + +XmNmaxX +XmCMaxX +Dimension +dynamic +G + + +XmNmaxY +XmCMaxY +Dimension +dynamic +G + + +XmNdefaultPixmapResolution +XmCDefaultPixmapResolution +unsigned short +100 +CSG + + +XmNpdmNotificationCallback +XmCCallback +XtCallbackList +NULL +CSG + + + + + + +XmNstartJobCallback + +Specifies the callback driving the beginning of rendering. +It is safe for an application to start rendering after +this callback has been activated. +XpStartJob +must be called +to trigger this callback. + + + + +XmNendJobCallback + +Specifies the callback driving the end of rendering. +Notify the client that all rendering has been processed +(whether on print-to-file or regular spool). +XpEndJob +is called by the print shell to trigger this callback. + + + + +XmNpageSetupCallback + +Specifies the callback driving the page layout. It is safe +for an app to start rendering from this callback even if the +XmNstartJobCallback +is not used. + + + + +XmNminX, XmNminY, XmNmaxX, XmNmaxY + +Specify the imageable area of the page in the current +print context. XmPrintShell also maintains a proper size at all times +by updating its own widget dimension whenever an attribute, +such as resolution or orientation, changes. It is sized in its +Initialize routine so that the application can rely on a proper size +before the first StartPage call is issued. + + + + +XmNdefaultPixmapResolution + +Indicates the resolution in dpi (dot per inch) of +the image files read and converted by Motif for the +widget descendants of this shell. It is used to +determine a scaling ratio to be applied to pixmap +created thru regular pixmap/icon conversion of the +following Widget resources: + + + +XmLabel.label*Pixmap, XmIconG.*IconPixmap +XmToggleB.selectPixmap, XmPushBG.armPixmap, +XmIconG.*IconMask, +XmMessageBox.symbolPixmap, +XmContainer.*StatePixmap, ... + + + +Leaving out the pixmap resources being used for +tiling (XmNhighlightPixmap, XmNtopShadowPixmap, +XmNbottomShadowPixmap, XmNbackgroundPixmap, ...) + + + + + + +XmNpdmNotificationCallback + +A callback notifying the application about the status of the PDM (see +XmPrintPopupPDM). A +XmPrintShellCallbackStruct +is used, with reason: + + + +XmCR_PDM_NONE: no PDM available on this display for +the named selection (provided in detail) + + + +XmCR_PDM_START_VXAUTH +: the PDM is not authorized to connect to the video display. + + + +XmCR_PDM_START_PXAUTH +: the PDM is not authorized to connect to the print display. + + + +XmCR_PDM_UP +: the PDM is up and running + + + +XmCR_PDM_OK +: the PDM has exited with OK status + + + +XmCR_PDM_CANCEL +: the PDM has exited with CANCEL + + + +XmCR_PDM_START_ERROR +: the PDM cannot start due to some error (usually logged) + + + +XmCR_PDM_EXIT_ERROR +: the PDM has exited with an error + + + + + + + + +Callback Information +The XmNstartJobCallback, XmNendJobCallback, +XmNpageSetupCallback and XmNpdmNotificationCallback +operate on a XmPrintShellCallbackStruct, which is defined as follow: + + +typedef struct +{ + int reason; /* XmCR_START_JOB, XmCR_END_JOB, + XmCR_PAGE_SETUP, XmCR_PDM_* */ + XEvent *event; + XPContext print_context; + Boolean last_page; /* in_out */ + XtPointer detail; +} XmPrintShellCallbackStruct; + + + +Additional Behavior +The last_page field +is only meaningful when the reason is +XmCR_PAGE_SETUP. + +The page setup callback is called with +last_page False to notify the application that it has +to get its internal layout state ready for the next +page. Typically, a widget based application will change +the content of a Label showing the page number, or scroll +the content of the Text widget. + +When the application has processed its last page, it +should set the last_page field in the callback struct +to True. The callback will be called a last time after +that with last_page +False to notify the application +that it can safely clean-up its internal state (e.g., +destroy widgets). + +No drawing should occur from within the callback function +in the application, this is an Exposure event-driven +programming model where widgets render themselves from +their expose methods. + +The print shell calls XpStartPage after the +pageSetupCallback returns, and XpEndPage +upon reception of StartPageNotify. + + + + +ERRORS/WARNINGS +XmPrintShell can generate the following warnings: + + + +Not connected to a valid X Print Server: behavior undefined. + + + +Attempt to set an invalid resolution on a printer: %s + + + +Attempt to set an invalid orientation on a printer: %s + + + + + +RETURN VALUE +Not applicable + + + +EXAMPLES + +PrintOnePageCB(Widget pshell, XtPointer npages, +/*----------*/ XmPrintSetPageCBStruct psp) +{ + static int cur_page = 0; + cur_page++; + + if (! psp->last_page + && curPage > 1) /* no need to scroll for the first page */ + { + + XmTextScroll(ptext, prows); /* get ready for next page */ + + } else { /**** I'm done */ + + XtDestroyWidget(pshell); + XtCloseDisplay(XtDisplay(pshell)); + } + + if (cur_page == (int) n_pages) psp->last_page = True; +} + +PrintOKCallback(...) +/*-------------*/ +{ + pshell = XmPrintSetup (widget, pbs->print_screen, + "Print", NULL, 0); + + XpStartJob(XtDisplay(pshell), XPSpool); + + /**** here I get the size of the shell, create my widget + hierarchy: a bulleting board, and then a text widget, + that I stuff with the video text widget buffer */ + + /* get the total number of pages to print */ + /* same code as previous example to get n_pages */ + + /**** set up my print callback */ + XtAddCallback(pshell, XmNpageSetUpCallback, + PrintOnePageCB, n_pages); +} + +Examples of XmNdefaultPixmapResolution usage: + + + +An application reuses the same image sources it uses for the video interface, in XBM or XPM, to layout on its printed pages. In this case, scaling is seamless. + + + ! icon.xpm is 30x30 pixels + app*dialog.pushb.labelPixmap:icon.xpm + ! print is 400dpi + app.print*form.lab.labelPixmap:icon.xpm + ! 120x120 pixels on the paper (auto scaling) + + + +An application provides a new set of image files, for a given printer resolution (say 300). It doesn't want automatic scaling by the toolkit for that resolution, it wants scaling based on these 300dpi images for higher resolution. It creates its print shell inside using the name "printHiRes" and adds the following in its resource file: + + + app.printHiRes.defaultPixmapResolution:300 + ! icon300.xpm is 120x120 pixels + app.printHiRes*form.lab.labelPixmap:icon300.xpm + ! 120x120 pixels on the paper (no scaling) + + + +This way a printer resolution of 600 will result in a scale of a +300 dpi image by 2 (dpi=600 divided by base=300), while a printer +resolution of 150 (using default print shell name "print") will use +the 100 dpi icon scaled by 1.5 (dpi=150 divided by default base=100). + + + +SEE ALSO +&cdeman.XmPrintSetup;, +&cdeman.XmRedisplayWidget;, +&cdeman.XmPrintToFile;, +&cdeman.XmPrintPopupPDM; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtToFil.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtToFil.sgm new file mode 100644 index 00000000..d82e2e21 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PrtToFil.sgm @@ -0,0 +1,155 @@ + + + + + + + + + + +XmPrintToFile +library call + + +XmPrintToFile + +Retrieves and saves data that +would normally be printed by the X Print Server. + + + + +#include <Xm/Print.h> + +XtEnumXmPrintToFile +Display*dpy +Stringfilename +XPFinishProcfinish_proc +XtPointerclient_data + + + +DESCRIPTION +XmPrintToFile +hides the details of X display connection and +XpGetDocumentData +to the Motif application programmer. + +This function is a convenience routine that hides +the details of the X and Xp internals to the +application programmer by calling the +XpGetDocumentData +function with appropriate save and finish callbacks. + +This is used in the context of X Printing when +the user has specified the "print-to-file" option from +a regular Print Setup Dialog box. + +XmPrintToFile +first tries to open the given filename for writing and returns +False +if it can't. +Else, it uses +XpGetDocumentData, giving it a save proc that writes the +data received in the file and a finish proc that closes the +file or removes it on an unsuccessful termination. +It calls +finish_proc +at that point, passing it the argument received from the +Xp layer (status == XPGetDocFinished +means the file is valid and was closed, otherwise the file was removed). + +XmPrintToFile is non-blocking; if it returns successfully, it +just means the file was opened successfully, not +that all the data was received. + + +dpy + +Print display connection. + + + +filename + +Name of the file to put the print data in. + + + +finish_proc + +Called when all the data has been received. + + + +client_data + +Passed with the finish_proc. + + + + + +RETURN VALUE +Returns False +if the filename could not be created or opened for writing, +True otherwise. + + +ERRORS/WARNINGS +Not applicable + + +EXAMPLES +A typical OK callback from a +DtPrintSetupBox: + + +PrintOKCallback(widget...) +/*-------------*/ +{ int save_data = XPSpool; + + pshell = XmPrintSetup (widget, pbs->print_screen, + "Print", NULL, 0); + + XtAddCallback(pshell, XmNstartJobCallback, startJobCB, data); + + if (pbs->destination == DtPRINT_TO_FILE) + save_data = XPGetData; + + /* start job must precede XpGetDocumentData in XmPrintToFile */ + XpStartJob(XtDisplay(pshell), save_data); + XFlush(XtDisplay(pshell)); /* maintain the sequence + between startjob and getdocument */ + + /* setup print to file */ + if (pbs->destination == DtPRINT_TO_FILE) + XmPrintToFile(XtDisplay(pshell), + pbs->dest_info, FinishPrintToFile, NULL); + } + +} + +static void +startJobCB(Widget, XtPointer call_data, XtPointer client_data) +{ + print(p); /* rendering happens here */ + + XpEndJob(XtDisplay(p->print_shell)); + + /* clean up */ + XtDestroyWidget(p->print_shell); + XtCloseDisplay(XtDisplay(p->print_shell)); +} + + + +SEE ALSO +&cdeman.XmPrintSetup;, +&cdeman.XmPrintShell;, +&cdeman.XmRedisplayWidget;, +&cdeman.XmPrintPopupPDM; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButA.sgm new file mode 100644 index 00000000..6c252562 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButA.sgm @@ -0,0 +1,1324 @@ + + + + + + + + + + + +XmPushButton +library call + + +XmPushButton +The PushButton widget class + +XmPushButton + +widget class +PushButton + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/PushB.h> + + + +DESCRIPTION +PushButton issues commands within an application. +It consists of a text label or pixmap surrounded +by a border shadow. +When a PushButton is selected, the shadow changes to give the appearance +that it has been pressed in. When a PushButton is +unselected, the shadow changes to give the appearance that it is out. + +The default behavior associated with a PushButton in a menu depends on +the type of menu system in which it resides. +By default, Btn1 controls the behavior of the PushButton. +In addition, Btn3 controls the behavior of the PushButton if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. + +Thickness for a second shadow, used when the PushButton is the default +button, may be specified with the +XmNshowAsDefault resource. If it has a nonzero value, the Label's +resources XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom may be modified to accommodate the second shadow. + +If an initial value is specified for XmNarmPixmap but not for +XmNlabelPixmap, the XmNarmPixmap value is used for +XmNlabelPixmap. + +PushButton uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits, and +holds the XmQactivatable, XmQTmenuSavvy, and +XmQTtakesDefault traits. + + +Classes +PushButton inherits behavior, resources, and traits from Core, +XmPrimitive, +and XmLabel. + +The class pointer is xmPushButtonWidgetClass. + +The class name is XmPushButton. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmPushButton Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmColor +XmCArmColor +Pixel +dynamic +CSG + + +XmNarmPixmap +XmCArmPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNdefaultButtonShadowThickness +XmCDefaultButtonShadowThickness +Dimension +dynamic +CSG + + +XmNdisarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNfillOnArm +XmCFillOnArm +Boolean +True +CSG + + +XmNmultiClick +XmCMultiClick +unsigned char +dynamic +CSG + + +XmNshowAsDefault +XmCShowAsDefault +Dimension +0 +CSG + + + + + + + +XmNactivateCallback + +Specifies the list of callbacks that is called when PushButton is activated. +PushButton is activated when the user presses +and releases the active mouse button +while the pointer is inside that widget. Activating the PushButton +also disarms it. +For this callback, the reason is XmCR_ACTIVATE. +This callback uses the XmQTactivatable trait. + + + + +XmNarmCallback + +Specifies the list of callbacks that is called when PushButton is armed. +PushButton is armed when the user presses +the active mouse button while the pointer is inside that +widget. +For this callback, the reason is XmCR_ARM. + + + + +XmNarmColor + +Specifies the color with which to fill the armed button. +XmNfillOnArm must be set to True for this resource to have an effect. +The default for a color display is a color between the background and the +bottom shadow color. For a monochrome display, the default is set to the +foreground color, and any text in the label appears in the background +color when the button is armed. + +This resource is also used when the button is armed in a menu +and the XmNenableEtchedInMenu resource is True. + + + + +XmNarmPixmap + +Specifies the pixmap to be used as the button face if XmNlabelType is +XmPIXMAP and PushButton is armed. This resource is disabled when the +PushButton is in a menu. + + + + +XmNdefaultButtonShadowThickness + +This resource specifies the width of the default button indicator shadow. +If this resource is 0 (zero), the width of the shadow comes from the value of +the XmNshowAsDefault resource. If this resource is greater than +0, the XmNshowAsDefault resource is only used to specify whether +this button is the default. +The default value is the initial value of XmNshowAsDefault. + + + + +XmNdisarmCallback + +Specifies the list of callbacks +that is called when PushButton is disarmed. PushButton is disarmed when +the user presses and releases the active mouse button +while the pointer is inside that widget. For this callback, the reason is +XmCR_DISARM. + + + + +XmNfillOnArm + +Forces the PushButton to fill the background of the button with the +color specified by XmNarmColor when the button is armed and when this +resource is set to True. If False, only the top and bottom +shadow colors are switched. +When the PushButton is in a menu, this resource is ignored and assumed to be +False. + + + + +XmNmultiClick + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, and this resource is +set to XmMULTICLICK_DISCARD, do not process the second click. +If this resource is set to XmMULTICLICK_KEEP, process the event +and increment click_count in the callback structure. +When the button is in a menu, the default is XmMULTICLICK_DISCARD; +otherwise, for a button not in a menu, XmMULTICLICK_KEEP is +the default value. + + + + +XmNshowAsDefault + +If XmNdefaultButtonShadowThickness is greater than 0 (zero), a value +greater than 0 in this resource +specifies to mark this button as the default button. +If XmNdefaultButtonShadowThickness is 0, a value greater than +0 in this resource specifies to mark this button as the default +button with the shadow thickness specified by this resource. +When the Display resource XmNdefaultButtonEmphasis has a value of +XmEXTERNAL_HIGHLIGHT (the default), PushButton draws the +location cursor outside of the outer shadow. When this resource has a +value of XmINTERNAL_HIGHLIGHT, the highlight is drawn between +the inner and outer shadows. +The space between +the shadow and the default shadow is equal to the sum of both shadows. +The default value is 0. When this value is not 0, the Label +resources XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom may be modified to accommodate the second shadow. +This resource is disabled when the PushButton is in a menu. + + + + + + +Inherited Resources +PushButton inherits behavior and resources from the +superclasses described the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabel Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +dynamic +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +dynamic +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +dynamic +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int click_count; +} XmPushButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +click_count + +This value is valid only when the reason is XmCR_ACTIVATE. +It contains the number of clicks in the last multiclick sequence +if the XmNmultiClick resource is set to XmMULTICLICK_KEEP, +otherwise it contains 1. +The activate callback is invoked for each click if XmNmultiClick +is set to XmMULTICLICK_KEEP. + + + + + + + + + + + + + + + + +Translations +XmPushButton includes translations from Primitive. + +Note that altering translations in #override +or #augment mode is undefined. + +Additional XmPushButton translations for XmPushButtons not in a +menu system are described in the following list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +c<Btn1Down>: + +ButtonTakeFocus() + + + + +≈cBtn1Down: + +Arm() + + + + +≈cBtn1Down,≈cBtn1Up: + +Activate() Disarm() + + + + +≈cBtn1Down(2+): + +MultiArm() + + + + +≈cBtn1Up(2+): + +MultiActivate() + + + + +≈cBtn1Up: + +Activate() Disarm() + + + + +≈cBtn2Down: + +ProcessDrag() + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfHelp: + +Help() + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + +XmPushButton inherits menu traversal translations +from XmLabel. +Additional XmPushButton translations for PushButtons in a +menu system are described in the following list. +In a Popup menu system, Btn3 also performs the Btn1 +actions. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +Btn2Down: + +ProcessDrag() + + + + +c<Btn1Down>: + +MenuButtonTakeFocus() + + + + +c<Btn1Up>: + +MenuButtonTakeFocusUp() + + + + +≈cBtnDown: + +BtnDown() + + + + +≈cBtnUp: + +BtnUp() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfActivate: + +ArmAndActivate() + + + + +:KeyosfCancel: + +MenuEscape() + + + + +:KeyosfHelp: + +Help() + + + + +≈s ≈m ≈a KeyReturn: + +ArmAndActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + + + +Action Routines +The XmPushButton action routines are + + + +Activate(): + +This action draws the shadow in the unarmed +state. +If the button is not in a menu and if XmNfillOnArm is set to True, +the background color reverts to the unarmed color. +If XmNlabelType is XmPIXMAP, XmNlabelPixmap is +used for the button face. +If the pointer is still within the button, +this action calls the callbacks for XmNactivateCallback. + + + + +Arm(): + +This action arms the PushButton. +It draws the shadow in the armed state. +If the button is not in a menu and if XmNfillOnArm is set +to True, it fills the button with the color specified by +XmNarmColor. +If XmNlabelType is XmPIXMAP, the XmNarmPixmap is +used for the button face. +It calls the XmNarmCallback callbacks. + + + + +ArmAndActivate(): + +In a menu, unposts all menus in the menu hierarchy and, +unless the button is already armed, +calls the XmNarmCallback callbacks. +This action calls the XmNactivateCallback and +XmNdisarmCallback callbacks. + +Outside a menu, draws the shadow in the armed state and, if +XmNfillOnArm is set to True, fills the button with the color +specified by XmNarmColor. +If XmNlabelType is XmPIXMAP, XmNarmPixmap is +used for the button face. +This action calls the XmNarmCallback callbacks. + +Outside a menu, this action also arranges for the following to happen, +either immediately or at a later time: +the shadow is drawn in the unarmed state and, if XmNfillOnArm is set +to True, the background color reverts to the unarmed color. +If XmNlabelType is XmPIXMAP, XmNlabelPixmap is +used for the button face. +The XmNactivateCallback and XmNdisarmCallback callbacks are +called. + + + + +BtnDown(): + +This action unposts any menus posted by the PushButton's parent menu, +disables keyboard traversal for the menu, and enables mouse traversal +for the menu. +It draws the shadow in the armed state +and, unless the button is already armed, calls the XmNarmCallback +callbacks. + + + + +BtnUp(): + +This action unposts all menus in the menu hierarchy and activates the +PushButton. +It calls the XmNactivateCallback callbacks and then the +XmNdisarmCallback callbacks. + + + + +ButtonTakeFocus(): + +Causes the PushButton to take keyboard focus +when Ctrl<Btn1Down> is pressed, without activating the widget. + + + + +Disarm(): + +Calls the callbacks for XmNdisarmCallback. + + + + +Help(): + +In a Pulldown or Popup MenuPane, unposts all menus in the menu hierarchy +and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to the widget that had the focus before +the menu system was entered. +This action calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +MenuShellPopdownOne(): + +In a top-level Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar; and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, it unposts the menu. + +In a Popup MenuPane, this action +unposts the menu and restores keyboard focus to the +widget from which the menu was posted. + + + + +MultiActivate(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +increments click_count in the callback structure and +draws the shadow in the unarmed state. +If the button is not in a menu and if XmNfillOnArm is set to True, +the background color reverts to the unarmed color. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used for the button face. +If the pointer is within the PushButton, calls the +callbacks for XmNactivateCallback +and XmNdisarmCallback. + + + + +MultiArm(): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +draws the shadow in the armed state. +If the button is not in a menu and if XmNfillOnArm is set +to True, this action fills the button with the color specified by +XmNarmColor. +If XmNlabelType is XmPIXMAP, the XmNarmPixmap is +used for the button face. +This action calls the XmNarmCallback callbacks. + + + + +ProcessDrag(): + +Drags the contents of a PushButton label, identified when +BTransfer is pressed. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. +This action is undefined for PushButtons used in a menu system. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +EnterWindow: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the armed state and calls the +XmNarmCallback callbacks. + +If the PushButton is not in a menu and the cursor leaves and then +reenters the PushButton's window while the button is pressed, this +action draws the shadow in the armed state. +If XmNfillOnArm is set to True, it also fills the button with the +color specified by XmNarmColor. +If XmNlabelType is XmPIXMAP, XmNarmPixmap is +used for the button face. + + + + +LeaveWindow: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the unarmed state and calls the +XmNdisarmCallback callbacks. + +If the PushButton is not in a menu and the cursor leaves the +PushButton's window while the button is pressed, this action draws the +shadow in the unarmed state. +If XmNfillOnArm is set to True, the background color reverts to +the unarmed color. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used for the button face. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmCreatePushButton;, &cdeman.XmLabel;, +&cdeman.XmPrimitive;, and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButB.sgm new file mode 100644 index 00000000..8a684d0e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/PushButB.sgm @@ -0,0 +1,999 @@ + + + + + + + + + + + +XmPushButtonGadget +library call + + +XmPushButtonGadget +The PushButtonGadget widget class + +XmPushButtonGadget + +widget class +PushButtonGadget + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/PushBG.h> + + + +DESCRIPTION +PushButtonGadget issues commands within an application. +It consists of a text label or pixmap surrounded +by a border shadow. +When PushButtonGadget is selected, the shadow changes to give the appearance +that the PushButtonGadget has been pressed in. When PushButtonGadget is +unselected, the shadow changes to give the appearance that the PushButtonGadget is +out. + +The default behavior associated with a PushButtonGadget in a menu depends on +the type of menu system in which it resides. +By default, Btn1 controls the behavior of the PushButtonGadget. +In addition, Btn3 controls the behavior of the PushButtonGadget if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. + +Thickness for a second shadow may be specified with the +XmNshowAsDefault resource. If it has a nonzero value, the Label's +XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom resources may be modified to accommodate the second shadow. + +If an initial value is specified for XmNarmPixmap but not for +XmNlabelPixmap, the XmNarmPixmap value is used for +XmNlabelPixmap. + +PushButtonGadget uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits, and +holds the XmQactivatable, XmQTmenuSavvy, and +XmQTtakesDefault traits. + + +Classes +PushButtonGadget inherits behavior, +resources, and traits from Object, RectObj, XmGadget +and XmLabelGadget. + +The class pointer is xmPushButtonGadgetClass. + +The class name is XmPushButtonGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmPushButtonGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNarmColor +XmCArmColor +Pixel +dynamic +CSG + + +XmNarmPixmap +XmCArmPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNdefaultButtonShadowThickness +XmCdefaultButtonShadowThickness +Dimension +dynamic +CSG + + +XmNdisarmCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNfillOnArm +XmCFillOnArm +Boolean +True +CSG + + +XmNmultiClick +XmCMultiClick +unsigned char +dynamic +CSG + + +XmNshowAsDefault +XmCShowAsDefault +Dimension +0 +CSG + + + + + + + +XmNactivateCallback + +Specifies the list of callbacks +that is called when the PushButtonGadget is activated. +It is activated when the user presses +and releases the active mouse button while the +pointer is inside +the PushButtonGadget. Activating PushButtonGadget +also disarms it. +For this callback, the reason is XmCR_ACTIVATE. +This callback uses the XmQTactivatable trait. + + + + +XmNarmCallback + +Specifies the list of callbacks +that is called when PushButtonGadget is armed. +It is armed when the user presses the active +mouse button while the pointer is inside the PushButtonGadget. +For this callback, the reason is XmCR_ARM. + + + + +XmNarmColor + +Specifies the color with which to fill the armed button. +XmNfillOnArm must be set to True for this resource to have an effect. +The default for a color display is a color between the background and the +bottom shadow color. For a monochrome display, the default is set to the +foreground color, and any text in the label appears in the background +color when the button is armed. + + + + +XmNarmPixmap + +Specifies the pixmap to be used as the button face if XmNlabeltype is +XmPIXMAP and PushButtonGadget is armed. +This resource is disabled when the PushButtonGadget is in a menu. + + + + +XmNdefaultButtonShadowThickness + +This resource specifies the width of the default button indicator shadow. +If this resource is 0 (zero), the width of the shadow comes from the value of +the XmNshowAsDefault resource. If this resource is greater than +zero, the XmNshowAsDefault resource is only used to specify whether +this button is the default. +The default value is the initial value of XmNshowAsDefault. + + + + +XmNdisarmCallback + +Specifies the list of callbacks +that is called when the PushButtonGadget is disarmed. +PushButtonGadget is disarmed when the user presses and releases the +active mouse button while the pointer is inside that +gadget. +For this callback, the reason is XmCR_DISARM. + + + + +XmNfillOnArm + +Forces the PushButtonGadget to fill the background of the button with the +color specified by XmNarmColor when the button is armed and when this +resource is set to True. If it is False, only the top and bottom +shadow colors are +switched. When the PushButtonGadget is in a menu, this resource is ignored +and assumed to be False. + + + + +XmNmultiClick + +If a button click is followed by another button click within the time +span specified by the display's multiclick time, and this resource is +set to XmMULTICLICK_DISCARD, the second click is not processed. +If this resource is set to XmMULTICLICK_KEEP, the event +is processed and click_count is incremented in the callback structure. +When the button is in a menu, the default is XmMULTICLICK_DISCARD; +otherwise, for a button not in a menu, the default value is +XmMULTICLICK_KEEP. + + + + +XmNshowAsDefault + +If XmNdefaultButtonShadowThickness is greater than 0 (zero), a value +greater than zero in this resource +specifies to mark this button as the default button. +If XmNdefaultButtonShadowThickness is 0, a value greater than +0 in this resource specifies to mark this button as the default +button with the shadow thickness specified by this resource. +The space between +the shadow and the default shadow is equal to the sum of both shadows. +The default value is 0. +When the Display resource XmNdefaultButtonEmphasis has a value of +XmEXTERNAL_HIGHLIGHT (the default), PushButton draws the +location cursor outside of the outer shadow. When this resource has a +value of XmINTERNAL_HIGHLIGHT, the highlight is drawn between +the inner and outer shadows. +When this value is not 0, the Label +XmNmarginLeft, XmNmarginRight, XmNmarginTop, and +XmNmarginBottom resources +may be modified to accommodate the second shadow. +This resource is disabled when the PushButton is in a menu. + + + + + + +Inherited Resources +PushButtonGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabelGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +dynamic +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +dynamic +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +dynamic +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +dynamic +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int click_count; +} XmPushButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +click_count + +Valid only when the reason is XmCR_ACTIVATE. +It contains the number of clicks in the last multiclick sequence +if the XmNmultiClick resource is set to XmMULTICLICK_KEEP; +otherwise it contains 1. +The activate callback is invoked for each click if XmNmultiClick +is set to XmMULTICLICK_KEEP. + + + + + + + + + + + + + + + + +Behavior +XmPushButtonGadget includes behavior from XmGadget. +XmPushButtonGadget includes menu traversal behavior from +XmLabelGadget. +Additional behavior for XmPushButtonGadget is described in the following +list. + + + +Btn2Down: + +Drags the contents of a PushButtonGadget label, identified when +Btn2 is pressed. +This action is undefined for PushButtonGadgets used in a menu system. + + + + +Btn1Down: + +This action arms the PushButtonGadget. + +In a menu, this action unposts any menus posted by the PushButtonGadget's +parent menu, disables keyboard traversal for the menu, and enables mouse +traversal for the menu. +It draws the shadow in the armed state. +Unless the button is already armed, it calls the XmNarmCallback +callbacks. + +If the button is not in a menu, this action draws the shadow in the +armed state. +If XmNfillOnArm is set +to True, it fills the button with the color specified by +XmNarmColor. +If XmNlabelType is XmPIXMAP, the XmNarmPixmap is +used for the button face. +It calls the XmNarmCallback callbacks. + + + + +Btn1(2+): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +draws the shadow in the armed state. +If the button is not in a menu and if XmNfillOnArm is set +to True, it fills the button with the color specified by +XmNarmColor. +If XmNlabelType is XmPIXMAP, the XmNarmPixmap is +used for the button face. +This action calls the XmNarmCallback callbacks. + + + + +Btn1Up: + +In a menu, this action unposts all menus in the menu hierarchy and +activates the PushButtonGadget. +It calls the XmNactivateCallback callbacks and then the +XmNdisarmCallback callbacks. + +If the PushButtonGadget is not in a menu, this action draws the shadow in the +unarmed state. +If XmNfillOnArm is set to True, the background color reverts to +the unarmed color. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used for the button face. +If the pointer is still within the button, +this action calls the callbacks for XmNactivateCallback +and XmNdisarmCallback. + + + + +Btn1Up(2+): + +If XmNmultiClick is XmMULTICLICK_DISCARD, this action does +nothing. + +If XmNmultiClick is XmMULTICLICK_KEEP, this action +increments click_count in the callback structure and +draws the shadow in the unarmed state. +If the button is not in a menu and if XmNfillOnArm is set to True, +the background color reverts to the unarmed color. +If XmNlabelType is XmPIXMAP, XmNlabelPixmap is +used for the button face. +If the pointer is within the PushButtonGadget, this action calls the +callbacks for XmNactivateCallback +and XmNdisarmCallback. + + + + +KeyosfActivate: + +In a menu, this action unposts all menus in the menu hierarchy, +unless the button is already armed, and calls the XmNarmCallback +callbacks, the XmNactivateCallback and +the XmNdisarmCallback callbacks. Outside a menu, KActivate +has no effect. +For PushButtonGadgets outside of a menu, if the parent is a manager, +this action passes the event to the parent. + + + + +KeyosfSelect: + +In a menu, this action +unposts all menus in the menu hierarchy, +unless the button is already armed, +and calls the XmNarmCallback callbacks. +This acton calls the XmNactivateCallback and +XmNdisarmCallback callbacks. + +Outside a menu, this action +draws the shadow in the armed state and, if +XmNfillOnArm is set to True, fills the button with the color +specified by XmNarmColor. +If XmNlabelType is XmPIXMAP, XmNarmPixmap is +used for the button face. +This action calls the XmNarmCallback callbacks. + +Outside a menu, this action also arranges for the following to happen, +either immediately or at a later time: +the shadow is drawn in the unarmed state and, if XmNfillOnArm is set +to True, the background color reverts to the unarmed color. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used for the button face. +The XmNactivateCallback and XmNdisarmCallback callbacks are +called. + + + + +KeyosfHelp: + +In a Pulldown or Popup MenuPane, unposts all menus in the menu hierarchy +and restores keyboard focus to the widget that had the focus before +the menu system was entered. +This action calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +KeyosfCancel: + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and restores keyboard focus to the +widget from which the menu was posted. +For a PushButtonGadget outside of a menu, if the parent is a manger, this +action passes the event to the parent. + + + + +Enter: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the armed state and calls the +XmNarmCallback callbacks. + +If the PushButtonGadget is not in a menu and the cursor leaves and then +reenters the PushButtonGadget while the button is pressed, this +action draws the shadow in the armed state. +If XmNfillOnArm is set +to True, it also fills the button with the +color specified by XmNarmColor. +If XmNlabelType is XmPIXMAP, the XmNarmPixmap is +used for the button face. + + + + +Leave: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the unarmed state and calls the +XmNdisarmCallback callbacks. + +If the PushButtonGadget is not in a menu and the cursor leaves the +PushButtonGadget while the button is pressed, this action draws the +shadow in the unarmed state. +If XmNfillOnArm is set to True, the background color reverts to +the unarmed color. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used for the button face. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Object;, &cdeman.RectObj;, +&cdeman.XmCreatePushButtonGadget;, +&cdeman.XmGadget;, +&cdeman.XmLabelGadget;, and &cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RedWidg.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RedWidg.sgm new file mode 100644 index 00000000..9eb19430 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RedWidg.sgm @@ -0,0 +1,165 @@ + + + + + + + + + + +XmRedisplayWidget +library call + + +XmRedisplayWidget + +Synchronously activates the expose method of a widget to draw its content + + + + +#include <Xm/Xm.h> + +voidXmRedisplayWidget +Widgetwidget + + +DESCRIPTION +This function is a convenience routine that hides the +details of the Xt internals to the application programmer by calling the +expose +method of the given widget with a well formed +Expose +event and +Region +corresponding to the total area of the widget. If the widget doesn't have an +Expose +method, the function does nothing. + +This is primarily used in the context of X Printing if the +programming model chosen by the application is synchronous; +that is, it doesn't rely of X Print events for the driving of +page layout but wants to completely control the sequence of rendering requests. + +XmRedisplayWidget +doesn't clear the widget window prior to calling the +expose +method, since this is handled by calls to +XpStartPage +. + + +widget + +The widget to redisplay. + + + + + +RETURN VALUE +None. + + +ERRORS/WARNINGS +Not applicable + + + +EXAMPLES +In the following, a simple application wants to +print the content of a multi-page text widget (similar to +dtpad). + + +PrintOKCallback(print_dialog...) +/*-------------*/ +{ + pshell = XmPrintSetup (print_dialog, pbs->print_screen, + "Print", NULL, 0); + + XpStartJob(XtDisplay(pshell), XPSpool); + + /**** here I realize the shell, get its size, create my widget + hierarchy: a bulletin board, and then a text widget, + that I stuff with the video text widget buffer */ + + /* get the total number of pages to print */ + XtVaGetValues(ptext, XmNrows, &prows, + XmNtotalLines, n_lines, NULL); + n_pages = n_lines / prows; + + /***** now print the pages in a loop */ + + for (cur_page=0; cur_page != n_pages; cur_page++) { + + XpStartPage(XtDisplay(pshell), XtWindow(pshell), False); + XmRedisplayWidget(ptext); /* do the drawing */ + XpEndPage(XtDisplay(pshell)); + + XmTextScroll(ptext, prows); /* get ready for next page */ + } + + /***** I'm done */ + XpEndJob(XtDisplay(pshell)); + +} + +Of course, one could change the above code to include it in a +fork() +branch so that the main program is not blocked while +printing is going on. Another way to achieve a +"print-in-the-background" effect is to use an Xt workproc. Using the +same sample application, that gives us: + + +Boolean +PrintOnePageWP(XtPointer npages) /* workproc */ +/*-------------*/ +{ + static int cur_page = 0; + cur_page++; + + XpStartPage(XtDisplay(pshell), XtWindow(pshell), False); + XmRedisplayWidget(ptext); /* do the drawing */ + XpEndPage(XtDisplay(pshell)); + + XmTextScroll(ptext, prows); /* get ready for next page */ + + if (cur_page == n_pages) { /***** I'm done */ + XpEndJob(XtDisplay(pshell)); + + XtDestroyWidget(pshell); + XtCloseDisplay(XtDisplay(pshell)); + } + + return (cur_page == n_pages); +} + +PrintOKCallback(...) +/*-------------*/ +{ + pshell = XmPrintSetup (widget, pbs->print_screen, + "Print", NULL, 0); + + XpStartJob(XtDisplay(pshell), XPSpool); + + /**** here I get the size of the shell, create my widget + hierarchy: a bulletin board, and then a text widget, + that I stuff with the video text widget buffer */ + + /* get the total number of pages to print */ + /* ... same code as above example */ + + /***** print the pages in the background */ + XtAppAddWorkProc(app_context, PrintOnePageWP, n_pages); +} + + +SEE ALSO +&cdeman.XmPrintSetup;, +&cdeman.XmPrintShell; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RegistS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RegistS.sgm new file mode 100644 index 00000000..d240d890 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RegistS.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmRegisterSegmentEncoding +library call + + +XmRegisterSegmentEncoding +A compound string function that registers +a compound text encoding format for a specified font list element tag + +XmRegisterSegment\\%Encoding + +compound string functions +XmRegisterSegment\\%Encoding + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +char * XmRegisterSegmentEncoding + +char *fontlist_tag +char *ct_encoding + + + +DESCRIPTION +XmRegisterSegmentEncoding registers a compound text encoding format +with the specified font list element tag. The XmCvtXmStringToCT +function uses this registry to map the font list tags of compound string +segments to compound text encoding formats. Registering +a font list tag that already exists in the registry overwrites the original +entry. You can unregister a font list tag by passing a NULL value for the +ct_encoding parameter. + + + +fontlist_tag + +Specifies the font list element tag to be registered. The +tag must be a NULL-terminated ISO8859-1 string. + + + + +ct_encoding + +Specifies the compound text character set to be used for segments +with the font list tag. The value must be a NULL-terminated ISO8859-1 string. +A value of XmFONTLIST_DEFAULT_TAG maps the specified font list tag to +the code set of the locale. + + + + + + +RETURN +Returns NULL for a new font list tag or the old ct_encoding +value for an already registered font list tag. The +application is responsible for freeing the +storage associated with the returned data (if any) by +calling XtFree. + + + +RELATED +&cdeman.XmCvtXmStringToCT;, +&cdeman.XmFontList;, +&cdeman.XmMapSegmentEncoding;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemFro.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemFro.sgm new file mode 100644 index 00000000..e00a3d41 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemFro.sgm @@ -0,0 +1,98 @@ + + + + + + + + + + + +XmRemoveFromPostFromList +library call + + +XmRemoveFromPostFromList +a RowColumn function that disables a menu for a particular widget + +XmRemoveFromPostFromList + +RowColumn functions +XmRemoveFromPostFromList + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +void XmRemoveFromPostFromList + +Widget menu +Widget post_from_widget + + + +DESCRIPTION +XmRemoveFromPostFromList makes a Popup or Pulldown menu no +longer accessible from a widget. This function does not destroy a +menu, or deallocate the memory associated with it. It simply removes +the widget from the menu's list of widgets permitted to post that +menu. + +If the menu argument refers to a Popup menu, the event handlers +are removed from the post_from_widget widget. If the argument +refers to a Pulldown menu, its ID is removed from the +XmNsubMenuId of the specified post_from_widget. Also, if +the menu is a Pulldown menu, the post_from_widget widget must be +either a CascadeButton or a CascadeButtonGadget. + + + +menu + +Specifies the widget ID of a the Popup or Pulldown menu to be +made inaccessible from the post_from_widget widget. + + + + +post_from_widget + +Specifies the widget ID of the widget which can no longer post the +menu referred to by the menu argument.. + + + + +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RELATED +&cdeman.XmAddToPostFromList;, +&cdeman.XmGetPostedFromWidget;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrA.sgm new file mode 100644 index 00000000..3786b9fd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrA.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmRemoveProtocolCallback +library call + + +XmRemoveProtocolCallback +A VendorShell function that removes a callback from the internal list + +XmRemoveProtocol\\%Callback + +VendorShell functions +XmRemoveProtocol\\%Callback + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmRemoveProtocolCallback + +Widget shell +Atom property +Atom protocol +XtCallbackProc callback +XtPointer closure + + + +DESCRIPTION +XmRemoveProtocolCallback removes a callback from the internal list. + +XmRemoveWMProtocolCallback is a convenience interface. +It calls XmRemoveProtocolCallback +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocol + +Specifies the protocol atom + + + + +callback + +Specifies the procedure to call when a protocol message is received + + + + +closure + +Specifies the client data to be passed to the callback when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddProtocolCallback;, +&cdeman.XmInternAtom;, and &cdeman.XmRemoveWMProtocolCallback;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrB.sgm new file mode 100644 index 00000000..d85a6d03 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemPrB.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmRemoveProtocols +library call + + +XmRemoveProtocols +A VendorShell function that removes the protocols from the protocol manager and deallocates the internal tables + +XmRemoveProtocols + +VendorShell functions +XmRemoveProtocols + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmRemoveProtocols + +Widget shell +Atom property +Atom * protocols +Cardinal num_protocols + + + +DESCRIPTION +XmRemoveProtocols removes the protocols from the protocol manager and +deallocates the internal tables. If any of the protocols are active, it +will update the handlers and update the property if shell is +realized. + +XmRemoveWMProtocols is a convenience interface. +It calls XmRemoveProtocols +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocols + +Specifies the protocol atoms + + + + +num_protocols + +Specifies the number of elements in protocols + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddProtocols;, +&cdeman.XmInternAtom;, and &cdeman.XmRemoveWMProtocols;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemTab.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemTab.sgm new file mode 100644 index 00000000..288cda62 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemTab.sgm @@ -0,0 +1,76 @@ + + + + + + + + + + + +XmRemoveTabGroup +library call + + +XmRemoveTabGroup +A function that removes a tab group + +XmRemoveTabGroup + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmRemoveTabGroup + +Widget tab_group + + + +DESCRIPTION +This function is obsolete and its behavior is replaced by setting +XmNnavigationType to XmNONE. +XmRemoveTabGroup removes a +widget from the list of tab groups +associated with a particular widget hierarchy and sets the widget's +XmNnavigationType to XmNONE. + + + +tab_group + +Specifies the widget ID + + + + + + +RELATED +&cdeman.XmAddTabGroup;, &cdeman.XmManager;, and &cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMA.sgm new file mode 100644 index 00000000..7eb904c9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMA.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmRemoveWMProtocolCallback +library call + + +XmRemoveWMProtocolCallback +A VendorShell convenience interface that removes a callback from the internal list + +XmRemoveWMProtocol\\%Callback + +VendorShell functions +XmRemoveWMProtocol\\%Callback + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmRemoveWMProtocolCallback + +Widget shell +Atom protocol +XtCallbackProc callback +XtPointer closure + + + +DESCRIPTION +XmRemoveWMProtocolCallback is a convenience interface. +It calls XmRemoveProtocolCallback +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocol + +Specifies the protocol atom + + + + +callback + +Specifies the procedure to call when a protocol message is received + + + + +closure + +Specifies the client data to be passed to the callback when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddWMProtocolCallback;, +&cdeman.XmInternAtom;, and &cdeman.XmRemoveProtocolCallback;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMB.sgm new file mode 100644 index 00000000..69985a83 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RemWMB.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmRemoveWMProtocols +library call + + +XmRemoveWMProtocols +A VendorShell convenience interface that removes the protocols from the protocol manager and deallocates the internal tables + +XmRemoveWMProtocols + +VendorShell functions +XmRemoveWMProtocols + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmRemoveWMProtocols + +Widget shell +Atom * protocols +Cardinal num_protocols + + + +DESCRIPTION +XmRemoveWMProtocols is a convenience interface. +It calls XmRemoveProtocols +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocols + +Specifies the protocol atoms + + + + +num_protocols + +Specifies the number of elements in protocols + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmAddWMProtocols;, +&cdeman.XmInternAtom;, and &cdeman.XmRemoveProtocols;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendA.sgm new file mode 100644 index 00000000..4649ead7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendA.sgm @@ -0,0 +1,291 @@ + + + + + + + + + + + +XmRendition +library call + + +XmRendition +The Rendition registry + +XmRendition + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +XmRendition + + + +DESCRIPTION +XmRendition is a pseudo widget used for the rendering of +XmStrings. XmRendition has two parts: +XmStringTag and rendering information. The XmStringTag part +can be matched with an XmStringTag associated with a +LOCALE, CHARSET, or RENDITION[BEGIN|END] component +within XmString. +The rendering information contains +information about the font or fontset, colors, tabs, and lines to be +used in rendering a text component. + +If a resource in a rendition is unspecified, usually by setting it to +XmAS_IS or XmUNSPECIFIED_PIXEL, +then the value to be used for that resource is the value of the +immediately preceeding rendition in XmString. If that value +is unspecified, then the preceding value is used, and so on. If +no renditions specify a value for a resource, then a default value +will be used. + + +Classes +XmRendition does not inherit from any widget class. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. To reference a resource by name +or by class in a .Xdefaults file, remove the XmN or XmC +prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix +and use the remaining letters (in either lowercase or uppercase, but include +any underscores between words). The codes in the access column +indicate if the given resource can be set at creation time (C), +set by using XmRenditionUpdate (S), retrieved by using +XmRenditionRetrieve (G), or is not applicable (N/A). + + + + + + + + + + + +XmRendition Resource Set + + +Name +Class +Type +Default +Access + + +XmNrenditionBackground +XmCRenditionBackground +Pixel +XmUNSPECIFIED_PIXEL +CSG + + +XmNfont +XmCFont +XtPointer +XmAS_IS +CSG + + +XmNfontName +XmCFontName +String +XmAS_IS +CSG + + +XmNfontType +XmCFontType +XmFontType +XmAS_IS +CSG + + +XmNrenditionForeground +XmCRenditionForeground +Pixel +XmUNSPECIFIED_PIXEL +CSG + + +XmNloadModel +XmCLoadModel +unsigned char +XmAS_IS +CSG + + +XmNstrikethruType +XmCStrikethruType +unsigned char +XmAS_IS +CSG + + +XmNtabList +XmCTabList +XmTabList +XmAS_IS +CSG + + +XmNtag +XmCTag +XmStringTag +"" +G + + +XmNunderlineType +XmCUnderlineType +unsigned char +XmAS_IS +CSG + + + + + + +XmNrenditionBackground + +Specifies the background drawing color. A value of +XmUNSPECIFIED_PIXEL indicates that the background is not +specified for this rendition. + + + + +XmNfont + +Specifies the actual font or fontset to be used by this rendition. The +value of this resource, if set to other than XmAS_IS, will be +used regardless of the settings of the other font resources. Setting +this resource will force XmNloadModel to be +XmLOAD_IMMEDIATE. If this resource is not initially set, then +it will be set subsequently by the rendition whenever the font or +fontset specified by XmNfontName is loaded. If both +XmNfontName and XmNfont are specified in a resource file, +the XmNfont specification will take precedence. + + + + +XmNfontName + +Specifies an X Logical Font Description (XLFD) string, which is +interpreted either as a font name or as a base font name list. A base +font name list is a comma-separated and NULL-terminated string. A +value of XmAS_IS indicates that the font is not specified for +this rendition. If both XmNfontName and XmNfont are +specified in a resource file, the XmNfont specification will +take precedence. + + + + +XmNfontType + +Specifies whether the +XmNfontName resource refers to a font name or to a base font name +list. Valid values are XmFONT_IS_FONT and +XmFONT_IS_FONTSET. + + + + +XmNrenditionForeground + +Specifies the foreground drawing color. A value of +XmUNSPECIFIED_PIXEL indicates that the foreground is not +specified for this rendition. + + + + +XmNloadModel + +Specifies whether the font or fontset specified by XmNfontName +is to be loaded when the rendition is created (XmLOAD_IMMEDIATE) +or only when the font is required to render an XmString segment +(XmLOAD_DEFERRED). +Note that specifying XmLOAD_IMMEDIATE for XmNloadModel is +valid only if XmNfontName is specified, in which case the +specified font will be loaded on creation, or if XmNfont is +specified, in which case the font is already loaded. +XmLOAD_DEFERRED is only valid when XmNfontName is +specified. + + + + +XmNstrikethruType + +Specifies the type of line to be used to strike through a text +segment. Valid values are XmNO_LINE, XmSINGLE_LINE, +XmDOUBLE_LINE, XmSINGLE_DASHED_LINE, and +XmDOUBLE_DASHED_LINE. A value of XmAS_IS indicates that +the strike-through type is not specified for this rendition. + + + + +XmNtabList + +Specifies the tab list to be used in rendering compound strings +containing tab components. + + + + +XmNtag + +Specifies the tag string to be used in matching the renditions with +other renditions or with XmStringTag components in +XmStrings. This resource must always be specified. That is, +NULL is not a legal value but the empty string is. +This resource is automatically set to the value of the tag parameter in +the XmRenditionCreate call. + + + + +XmNunderlineType + +Specifies the type of line to be used to underline a text segment. +Valid values are XmNO_LINE, XmSINGLE_LINE, +XmDOUBLE_LINE, XmSINGLE_DASHED_LINE, and +XmDOUBLE_DASHED_LINE. A value of XmAS_IS indicates that +the underline type is not specified for this rendition. + + + + + + + +RELATED +&cdeman.XmRenditionCreate;, +&cdeman.XmRenditionFree;, +&cdeman.XmRenditionRetrieve;, +&cdeman.XmRenditionUpdate;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendB.sgm new file mode 100644 index 00000000..4a60e5c8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendB.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmRenditionCreate +library call + + +XmRenditionCreate +A convenience function that creates a rendition + +XmRenditionCreate + + + + + + + + + + +#include <Xm/Xm.h> + +XmRendition XmRenditionCreate + +Widget widget +XmStringTag tag +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmRenditionCreate creates a rendition whose resources are set +to the values specified in arglist. Default values are assigned +to resources that are not specified. + + + +widget + +Specifies the widget used for deriving any necessary information for +creating the rendition. In particular, the X display of widget +will be used for loading fonts. + + + + +tag + +Specifies the tag for the rendition. +(This will become the XmNtag resource for the rendition.) + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + + + +RETURN +Returns the created rendition. +The function allocates space to hold the returned rendition. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XmRenditionFree. + + + +RELATED +&cdeman.XmRendition; and +&cdeman.XmRenditionFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendC.sgm new file mode 100644 index 00000000..ba2537a0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendC.sgm @@ -0,0 +1,57 @@ + + + + + + + + + + + +XmRenditionFree +library call + + +XmRenditionFree +A convenience function that frees a rendition + +XmRenditionFree + + + + + + + + + + +#include <Xm/Xm.h> + +void XmRenditionFree + +XmRendition rendition + + + +DESCRIPTION +XmRenditionFree recovers memory used by rendition. + + + +rendition + +Specifies the rendition to be freed. + + + + + + +RELATED +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendD.sgm new file mode 100644 index 00000000..3eb6661c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendD.sgm @@ -0,0 +1,81 @@ + + + + + + + + + + + +XmRenditionRetrieve +library call + + +XmRenditionRetrieve +A convenience function that retrieves rendition resources + +XmRenditionRetrieve + + + + + + + + + + +#include <Xm/Xm.h> + +void XmRenditionRetrieve + +XmRendition rendition +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmRenditionRetrieve extracts values for the given resources +(arglist) from the specified rendition. +Note that the function returns the actual values of the resources, not +copies. Therefore it is necessary to copy before modifying any +resource whose value is an address. This will include such resources +as XmNfontName, XmNfont, and XmNtabList. + + + +rendition + +Specifies the rendition. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + + + +RELATED +&cdeman.XmRendition; +and +&cdeman.XmTabListCopy;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendE.sgm new file mode 100644 index 00000000..9ffc769d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendE.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + + +XmRenditionUpdate +library call + + +XmRenditionUpdate +A convenience function that modifies resources + +XmRenditionUpdate + + + + + + + + + + +#include <Xm/Xm.h> + +void XmRenditionUpdate + +XmRendition rendition +ArgList arglist +Cardinal argcount + + + +DESCRIPTION +XmRenditionUpdate modifies resources in the specified rendition. + + + +rendition + +Specifies the rendition. + + + + +arglist + +Specifies the argument list. + + + + +argcount + +Specifies the number of attribute/value pairs in the argument list +(arglist). + + + + + + +RELATED +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaA.sgm new file mode 100644 index 00000000..e0382058 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaA.sgm @@ -0,0 +1,189 @@ + + + + + + + + + + + +XmRenderTable +library call + + +XmRenderTable +Data type for a render table + +XmRenderTable + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +XmRenderTable + + + +DESCRIPTION +XmRenderTable is the data type for a render table, which +contains a table of renditions (XmRenditions). Each rendition +consists of a set of attributes for rendering text, including a font +or fontset, colors, tabs, and lines. +Each rendition is identified with a tag. + +When a compound string is displayed, for each segment in the string, +the rendition used to render that string is formed as follows. If the +segment has at least one rendition begin tag or if the list of tags +formed by accumulating from previous segments the rendition begin tags +and removing the rendition end tags is not empty, these tags are +matched with renditions in the render table. The effective rendition +used to render the segment is formed by successively merging each +rendition found into the current rendition with non-XmAS_IS +(XmUNSPECIFIED_PIXEL for color resources) values for resources +in the rendition to be merged, thus replacing the corresponding values of +the resources in the current rendition. Finally, if the resulting +rendition still has resources with unspecified values and the segment +has a locale or charset tag (these are optional and mutually +exclusive) this tag is matched with a rendition in the render table, +and the missing rendition values are filled in from that entry. + +If no matching rendition is found for a particular tag, then the +XmNnoRenditionCallback of the XmDisplay object is called +and the render table is searched again for that tag. + +If the resulting rendition does not specify a font or fontset, then +for segments whose text type is XmCHARSET_TEXT, the render table +will be searched for a rendition tagged with +XmFONTLIST_DEFAULT_TAG, and if a matching rendition is found, it +will be merged into the current rendition. If the resulting rendition +contains no font or fontset, the XmNnoFontCallback will be +called with the default rendition and "" as the font name. If no +rendition matches or no font was found after the callback, then the +first rendition in the render table will be merged into the current +rendition. If this rendition still has no font, then the segment will +not be rendered and a warning will be emitted. + +For segments whose text type is XmMULTIBYTE_TEXT or +XmWIDECHAR_TEXT, the +render table will be searched for a rendition tagged with +_MOTIF_DEFAULT_LOCALE, and, if a matching rendition is found, it will be +merged into the current rendition. If the resulting rendition contains no +font, the XmNnoFontCallback will be called with the +default rendition and "" as the font name. +An application can have this callback attempt +to remedy this problem by calling XmRenditionUpdate on the input +rendition to provide a font for the widget to use. This may be done by +either providing an alternative font name to be loaded using the +XmNfontName and XmNfontType resources or with an already +loaded font using the XmNfont resource. +If no rendition matches or no font was found after the +callback, then the segment will not be rendered +and a warning will be issued. + +Render tables are specified in resource files with the following +syntax: + +resource_spec: [ tag [, tag ]* ] + +where tag is some string suitable for the XmNtag resource +of a rendition. + +If no tags are specified, then a render table will be created that is +either empty or contains only a rendition with a tag of +_MOTIF_DEFAULT_LOCALE. + +Specific values for specific rendition resources are specified using +the following syntax: + +resource_spec [*|.] rendition[*|.] resource_name: value + +where: + + + +resource_spec + +Specifies the render table. + + + + +rendition + +Is either the class Rendition or a tag. + + + + +resource_name + +Is either +the class or name of a particular resource. + + + + +value + +Is the +specification of the value to be set. + + + + +Any resource line that consists of just a resource name or class +component with no rendition component or loose binding will be +assumed to specify resource values for a rendition with a tag of +_MOTIF_DEFAULT_LOCALE. In effect, this creates a default +rendition in much the same way that specifying no fontlist tag for a +fontlist resource causes the fontlist created to contain an entry +tagged with XmFONTLIST_DEFAULT_TAG: + +resource_spec.resource_name: value + +For example, the following would set the XmNrenderTable resource +of label1 to a render +table consisting of three renditions tagged with +_MOTIF_DEFAULT_LOCALE, bold, and oblique, with values +for resources set as described in the resource specifications. + + +*label1.renderTable: bold, oblique +*label1.renderTable.bold.renditionForeground: Green +*label1.renderTable.bold.fontName: *-*-*-bold-*-iso8859-1 +*label1.renderTable.bold.fontType: FONT_IS_FONT +*label1.renderTable.oblique.renditionBackground: Red +*label1.renderTable.oblique.fontName: *-*-*-italic-*-iso8859-1 +*label1.renderTable.oblique.fontType: FONT_IS_FONT +*label1.renderTable.oblique.underlineType: AS_IS +*label1.renderTable.fontName: fixed +*label1.renderTable.fontType: FONT_IS_FONT +*label1.renderTable.renditionForegound: black +*label1.renderTable*tabList: 1in, +1.5in, +3in + + + + +RELATED +&cdeman.XmRenderTableAddRenditions;, +&cdeman.XmRenderTableCopy;, +&cdeman.XmRenderTableCvtFromProp;, +&cdeman.XmRenderTableCvtToProp;, +&cdeman.XmRenderTableFree;, +&cdeman.XmRenderTableGetRendition;, +&cdeman.XmRenderTableGetRenditions;, +&cdeman.XmRenderTableGetTags;, +&cdeman.XmRenderTableRemoveRenditions;, +&cdeman.XmRendition;, and +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaB.sgm new file mode 100644 index 00000000..db816bb2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaB.sgm @@ -0,0 +1,135 @@ + + + + + + + + + + +XmRenderTableAddRenditions +library call + + +XmRenderTableAddRenditions +Creates a new render table + +XmRenderTableAddRenditions + + + + +#include <Xm/Xm.h> + +XmRenderTable XmRenderTableAddRenditions +XmRenderTable oldtable +XmRendition *renditions +Cardinal rendition_count +XmMergeMode merge_mode + + + +DESCRIPTION +XmRenderTableAddRenditions is a function to create a new render +table that +includes the renditions listed in oldtable, if there is one. This +function also copies +specified renditions (renditions) to the new render table. The first +rendition_count renditions of the renditions array are +added to the new table. If a rendition is tagged with a tag +that matches a tag already in oldtable, then the existing +rendition using that tag is either modified or freed and replaced with +the new rendition, depending on the value of merge_mode. If +oldtable is NULL, +XmRenderTableAddRenditions creates a new render table containing +only the specified renditions. + +This function deallocates the original render table after extracting +the required information. It is the responsibility of the caller to +free the renditions of the renditions array by calling the +XmRenditionFree function. + + + +oldtable + +Specifies the render table to be added to. + + + + +renditions + +Specifies an array of renditions to be added. + + + + +rendition_count + +Specifies the number of renditions from renditions to be added. + + + + +merge_mode + +Specifies what to do if the XmNtag of a rendition matches that +of one that already exists in oldtable. The possible values +are as follows: + + + +XmMERGE_REPLACE + +Completely replaces the old rendition with the new one. + + + + +XmMERGE_OLD + +Replaces any unspecified values of the old rendition with the +corresponding values from the new rendition. + + + + +XmMERGE_NEW + +Replaces the old rendition with the new rendition, replacing any +unspecified values of the new rendition with the corresponding values +from the old rendition. + + + + +XmSKIP + +Skips over the new rendition, leaving the old rendition intact. + + + + + + + + + +RETURN +If renditions is NULL or rendition_count is 0 (zero), this +function returns oldtable. +Otherwise, the function returns a new XmRenderTable. +The function allocates space to hold this new render table. +The application is responsible for managing this allocated space. +The application can recover the allocated space by calling XmRenderTableFree. + + + +RELATED +&cdeman.XmRendition; and +&cdeman.XmRenderTableFree;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaC.sgm new file mode 100644 index 00000000..5b63b6a1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaC.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmRenderTableCopy +library call + + +XmRenderTableCopy +A render table function that copies renditions + +XmRenderTableCopy + + + + + + + + + + +#include <Xm/Xm.h> + +XmRenderTable XmRenderTableCopy + +XmRenderTable table +XmStringTag *tags +int tag_count + + + +DESCRIPTION +XmRenderTableCopy creates a new render table +which will contain +the renditions of the table whose tags match those in tags. + + + +table + +Specifies the table containing the renditions to be copied. + + + + +tags + +Specifies an array of tags, whose corresponding renditions are to be +copied. NULL indicates that the complete table should be copied. + + + + +tag_count + +Specifies the number of tags in tags. + + + + + + +RETURN +Returns NULL if table is NULL. Otherwise, this function returns +the new render table. +This function allocates space to hold the new render table. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XmRenderTableFree. + + + +RELATED +&cdeman.XmRendition; and +&cdeman.XmRenderTableFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaD.sgm new file mode 100644 index 00000000..30ef07b6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaD.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmRenderTableCvtFromProp +library call + + +XmRenderTableCvtFromProp +A render table function that converts from a string representation to a render table + +XmRenderTableCvtFromProp + +render table functions +XmRenderTableCvtFromProp + + + + + + + + + + +#include <Xm/Xm.h> + +XmRenderTable XmRenderTableCvtFromProp + +Widget widget +char *property +unsigned int length + + + +DESCRIPTION +XmRenderTableCvtFromProp converts a string of characters representing a +render table to a render table. +This routine is typically used by the destination of a data transfer +operation to produce a render table from a transferred representation. + + + +widget + +Specifies the widget that is the destination for the render table + + + + +property + +Specifies a string of characters representing a render table + + + + +length + +Specifies the number of bytes in property + + + + + + +RETURN +Returns a render table. +The function allocates space to hold the returned render table. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XmRenderTableFree. + + + +RELATED +&cdeman.XmRenderTable;, +&cdeman.XmRenderTableCvtToProp;, and +&cdeman.XmRenderTableFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaE.sgm new file mode 100644 index 00000000..878f84c4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaE.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmRenderTableCvtToProp +library call + + +XmRenderTableCvtToProp +A render table function that converts a render table to a string representation + +XmRenderTableCvtToProp + +render table functions +XmRenderTableCvtToProp + + + + + + + + + + +#include <Xm/Xm.h> + +unsigned int XmRenderTableCvtToProp + +Widget widget +XmRenderTable table +char **prop_return + + + +DESCRIPTION +XmRenderTableCvtToProp converts a render table to a string of +characters representing the render table. +This routine is typically used by the source of a data transfer +operation to produce a representation for transferring a render table to +a destination. + + + +widget + +Specifies the widget that is the source of the render table + + + + +table + +Specifies a render table to be converted + + + + +prop_return + +Specifies a pointer to a string that is created and returned by this +function. +The function allocates space to hold the returned string. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XtFree. + + + + + + +RETURN +Returns the number of bytes in the string representation. + + + +RELATED +&cdeman.XmRenderTable; and +&cdeman.XmRenderTableCvtFromProp;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaF.sgm new file mode 100644 index 00000000..2832dc5a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaF.sgm @@ -0,0 +1,58 @@ + + + + + + + + + + + +XmRenderTableFree +library call + + +XmRenderTableFree +A render table function that recovers memory + +XmRenderTableFree + + + + + + + + + + +#include <Xm/Xm.h> + +void XmRenderTableFree + +XmRenderTable table + + + +DESCRIPTION +XmRenderTableFree frees the memory associated with the specified +render table. + + + +table + +Specifies the table to be freed. + + + + + + +RELATED +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaG.sgm new file mode 100644 index 00000000..6ac30f1a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaG.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmRenderTableGetRendition +library call + + +XmRenderTableGetRendition +A convenience function that matches a rendition tag + +XmRenderTableGetRendition + + + + + + + + + + +#include <Xm/Xm.h> + +XmRendition XmRenderTableGetRendition + +XmRenderTable table +XmStringTag tag + + + +DESCRIPTION +XmRenderTableGetRendition searches table and returns a +copy of the rendition whose XmNtag resource matches tag. +If no rendition matches, then NULL is returned. This function is to +be used for just one rendition match. + +It is the responsibility of the caller to free the returned rendition +with the XmRenditionFree function. + + + +table + +Specifies the table containing renditions to be searched. + + + + +tag + +Specifies the tag to search for. + + + + + + +RETURN +Returns NULL if there is no match; otherwise, this function returns a +new XmRendition. + + + +RELATED +&cdeman.XmRenderTableGetRenditions;, +&cdeman.XmRenderTableGetTags;, and +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaH.sgm new file mode 100644 index 00000000..9854f3cf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaH.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmRenderTableGetRenditions +library call + + +XmRenderTableGetRenditions +A convenience function that matches rendition tags + +XmRenderTableGetRenditions + + + + + + + + + + +#include <Xm/Xm.h> + +XmRendition *XmRenderTableGetRenditions + +XmRenderTable table +XmStringTag *tags +Cardinal tag_count + + + +DESCRIPTION +XmRenderTableGetRenditions searches table and returns an +array of +copies of the renditions whose XmNtag resources match a tag +in tags. +If no renditions match, then NULL is returned. The size of the +returned array is tag_count. The XmNtag resource of each +rendition will match the corresponding tag in tags. If no match +is found for a particular tag, the corresponding slot in the return +value will be NULL. + +It is the responsibility of the caller to call the +XmRenditionFree function to free the new renditions, and the +XtFree function to free the array. + + + +table + +Specifies the table containing renditions to be searched. + + + + +tags + +Specifies the tags to search for. + + + + +tag_count + +Specifies the number of tags in tags. + + + + + + +RETURN +Returns NULL if there is no match; otherwise, this function returns an +array of +new XmRenditions. + + + +RELATED +&cdeman.XmRenderTableGetRendition;, +&cdeman.XmRenderTableGetTags;, and +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaI.sgm new file mode 100644 index 00000000..bc6ad824 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaI.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmRenderTableGetTags +library call + + +XmRenderTableGetTags +A convenience function that gets rendition tags + +XmRenderTableGetTags + + + + + + + + + + + +#include <Xm/Xm.h> + +int XmRenderTableGetTags + +XmRenderTable table +XmStringTag **tag_list + + + +DESCRIPTION +XmRenderTableGetTags searches the specified table for the +XmNtag resources of all the renditions (XmRenditions) +entries. These tag resources are then composed into an array. + + + +table + +Specifies the table containing the XmRenditions. + + + + +tag_list + +Is the array of XmStringTags generated by this function. +The function allocates space to hold the returned tags +and to hold the tag_list itself. +The application is responsible for managing this allocated space. +This application can recover this allocated space by calling XtFree +once for each of the returned tags, and then calling XtFree on the +returned tag_list variable itself. + + + + + + +RETURN +Returns the number of tags in tag_list. + + + +RELATED +&cdeman.XmRendition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaJ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaJ.sgm new file mode 100644 index 00000000..da47d813 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RendTaJ.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmRenderTableRemoveRenditions +library call + + +XmRenderTableRemoveRenditions +A convenience function that removes renditions + +XmRenderTableRemoveRenditions + + + + + + + + + + + +#include <Xm/Xm.h> + +XmRenderTable XmRenderTableRemoveRenditions + +XmRenderTable oldtable +XmStringTag *tags +int tag_count + + + +DESCRIPTION +XmRenderTableRemoveRenditions removes from oldtable the +renditions whose tags match the tags specified in tags, then +places the remaining renditions in a newly created render table. + + + +oldtable + +Specifies the render table from which renditions are to be removed. +This function deallocates the original render table and the matching +renditions after extracting the required information. + + + + +tags + +Specifies an array of tags, whose corresponding renditions are to be +removed from oldtable. + + + + +tag_count + +Specifies the number of tags in tags. + + + + + + +RETURN +If oldtable or tags is NULL, or tag_count is 0 +(zero), or no renditions are removed from oldtable, this +function returns oldtable. Otherwise, it returns a newly +allocated XmRenderTable. +The application is responsible for managing this allocated render table. +The application can recover this allocated space by calling XmRenderTableFree. + + + +RELATED +&cdeman.XmRendition; and +&cdeman.XmRenderTableFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypAd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypAd.sgm new file mode 100644 index 00000000..18dfd83d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypAd.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmRepTypeAddReverse +library call + + +XmRepTypeAddReverse +A representation type manager function +that installs the reverse converter for a previously registered representation type + +XmRepTypeAddReverse + +representation type manager functions +XmRepTypeAddReverse + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +void XmRepTypeAddReverse + +XmRepTypeId rep_type_id + + + +DESCRIPTION +XmRepTypeAddReverse installs the reverse converter +for a previously registered representation type. The reverse +converter takes a numerical representation type value and returns +its corresponding string value. Certain applications may require +this capability to obtain a string value to display on a screen +or to build a resource file. + +The values argument of the XmRepTypeRegister function +can be used to register representation types with nonconsecutive +values or with duplicate names for the same value. If the list +of numerical values for a representation type contains duplicate values, +the reverse converter uses the first name in the value_names +list that matches the specified numeric value. For example, if +a value_names array has cancel, proceed, and +abort, and the corresponding +values array contains 0, 1, and 0, the reverse converter +will return cancel instead of abort for an +input value of 0. + + + +rep_type_id + +Specifies the identification number of the representation type + + + + + + +RELATED +&cdeman.XmRepTypeGetId; and +&cdeman.XmRepTypeRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGA.sgm new file mode 100644 index 00000000..67338be8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGA.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmRepTypeGetId +library call + + +XmRepTypeGetId +A representation type manager function that +retrieves the identification number of a representation type + +XmRepTypeGetId + +representation type manager functions +XmRepTypeGetId + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +XmRepTypeId XmRepTypeGetId + +String rep_type + + + +DESCRIPTION +XmRepTypeGetId searches the registration list +for the specified representation type and returns the +associated identification number. + + + +rep_type + +Specifies the representation type for which an identification +number is requested + + + + + + +RETURN +Returns the identification number of the specified +representation type. If the representation type is not +registered, the function returns XmREP_TYPE_INVALID. + + + +RELATED +&cdeman.XmRepTypeGetRegistered; and +&cdeman.XmRepTypeRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGB.sgm new file mode 100644 index 00000000..bdc7e39a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGB.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmRepTypeGetNameList +library call + + +XmRepTypeGetNameList +A representation type manager function that +generates a list of values for a representation type + +XmRepTypeGetNameList + +representation type manager functions +XmRepTypeGetNameList + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +String * XmRepTypeGetNameList + +XmRepTypeId rep_type_id +Boolean use_uppercase_format + + + +DESCRIPTION +XmRepTypeGetNameList generates a NULL-terminated list of +the value names associated with the specified representation type. +Each value name is a NULL-terminated string. This routine allocates +memory for the returned data. The application must free +this memory using XtFree. + + + +rep_type_id + +Specifies the identification number of the representation type. + + + + +use_uppercase_format + +Specifies a Boolean value that controls the format of the name +list. If the value is True, each value name is in uppercase characters prefixed +by Xm; if it is False, the names are in lowercase characters. + + + + + + +RETURN +Returns a pointer to an array of the value names. + + + +RELATED +&cdeman.XmRepTypeGetId;, +&cdeman.XmRepTypeGetRegistered;, and +&cdeman.XmRepTypeRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGC.sgm new file mode 100644 index 00000000..ced7f5fb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGC.sgm @@ -0,0 +1,146 @@ + + + + + + + + + + + +XmRepTypeGetRecord +library call + + +XmRepTypeGetRecord +A representation type manager function that +returns information about a representation type + +XmRepTypeGetRecord + +representation type manager functions +XmRepTypeGetRecord + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +XmRepTypeEntry XmRepTypeGetRecord + +XmRepTypeId rep_type_id + + + +DESCRIPTION +XmRepTypeGetRecord retrieves information about +a particular representation type that is registered with +the representation type manager. This routine allocates +memory for the returned data. The application must free +this memory using XtFree. + + + +rep_type_id + +The identification number of the representation type + + + + +The representation type entry structure contains the following +information: + + +typedef struct +{ + String rep_type_name; + String *value_names; + unsigned char *values; + unsigned char num_values; + Boolean reverse_installed; + XmRepTypeId rep_type_id; +} XmRepTypeEntryRec, *XmRepTypeEntry; + + + + + + +rep_type_name + +The name of the representation type + + + + +value_names + +An array of representation type value names + + + + +values + +An array of representation type numerical values + + + + +num_values + +The number of values associated with the representation type + + + + +reverse_installed + +A flag that indicates whether or not the reverse converter is +installed + + + + +rep_type_id + +The identification number of the representation type + + + + + + +RETURN +Returns a pointer to the representation type entry structure that +describes the representation type. + + + +RELATED +&cdeman.XmRepTypeGetId;, +&cdeman.XmRepTypeGetRegistered;, and +&cdeman.XmRepTypeRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGD.sgm new file mode 100644 index 00000000..c43ce059 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypGD.sgm @@ -0,0 +1,141 @@ + + + + + + + + + + + +XmRepTypeGetRegistered +library call + + +XmRepTypeGetRegistered +A representation type manager function that +returns a copy of the registration list + +XmRepTypeGetRegistered + +representation type manager functions +XmRepTypeGetRegistered + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +XmRepTypeList XmRepTypeGetRegistered + + + + +DESCRIPTION +XmRepTypeGetRegistered retrieves information about +all representation types that are registered with the +representation type manager. The registration list is +an array of structures, each of which contains information +for a representation type entry. The end of the registration +list is marked with a representation type entry whose +rep_type_name field has a NULL pointer. This routine +allocates memory for the returned data. The application must free +this memory using XtFree. + +The representation type entry structure contains the following +information: + + + +typedef struct +{ + String rep_type_name; + String *value_names; + unsigned char *values; + unsigned char num_values; + Boolean reverse_installed; + XmRepTypeId rep_type_id; +} XmRepTypeEntryRec, *XmRepTypeList; + + + + + + +rep_type_name + +The name of the representation type + + + + +value_names + +An array of representation type value names + + + + +values + +An array of representation type numerical values + + + + +num_values + +The number of values associated with the representation type + + + + +reverse_installed + +A flag that indicates whether or not the reverse converter is +installed + + + + +rep_type_id + +The identification number of the representation type + + + + + + + + +RETURN +Returns a pointer to the registration list of representation types. + + + +RELATED +&cdeman.XmRepTypeRegister; and +&cdeman.XmRepTypeGetRecord;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypIn.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypIn.sgm new file mode 100644 index 00000000..3b8d8ade --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypIn.sgm @@ -0,0 +1,61 @@ + + + + + + + + + + + +XmRepTypeInstallTearOffModelConverter +library call + + +XmRepTypeInstallTearOffModelConverter +A representation type manager function +that installs the resource converter for XmNtearOffModel. + +XmRepTypeInstallTearOff\\%ModelConverter + +representation type manager functions +XmRepTypeInstallTearOff\\%ModelConverter + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +void XmRepTypeInstallTearOffModelConverter + + + + +DESCRIPTION +XmRepTypeInstallTearOffModelConverter installs the resource +converter that allows values for the XmNtearOffModel resource +to be specified in resource default files. + + + +RELATED +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypRe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypRe.sgm new file mode 100644 index 00000000..22f35283 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypRe.sgm @@ -0,0 +1,145 @@ + + + + + + + + + + + +XmRepTypeRegister +library call + + +XmRepTypeRegister +A representation type manager function +that registers a representation type resource + +XmRepTypeRegister + +representation type manager functions +XmRepTypeRegister + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +XmRepTypeId XmRepTypeRegister + +String rep_type +String *value_names +unsigned char *values +unsigned char num_values + + + +DESCRIPTION +XmRepTypeRegister registers a representation +type resource with the representation type manager. All +features of the representation type management facility become +available for the specified representation type. The function +installs a forward type converter to convert string values to +numerical representation type values. + +When the values argument is NULL, consecutive numerical +values are assumed. The order of the strings in the value_names +array determines the numerical values for the resource. For example, +the first value name is 0 (zero); the second value name is 1; and so on. + +If it is non-NULL, the values argument can be used to assign values +to representation types that have nonconsecutive values or have +duplicate names for the same value. Representation types registered +in this manner will consume additional storage and will be slightly +slower than representation types with consecutive values. + +A representation type can only be registered once; if the +same representation type name is registered more than once, the +behavior is undefined. + +The function XmRepTypeAddReverse installs a reverse converter +for a registered representation type. The reverse converter takes +a representation type numerical value and returns the corresponding +string value. If the list of numerical values for a representation +type contains duplicate values, the reverse converter uses the first +name in the value_names list that matches the specified numeric +value. For example, if a value_names array has cancel, +proceed, and abort, and the corresponding values array +contains 0, 1, and 0, the reverse converter will return cancel +instead of abort for an input value of 0. + + + +rep_type + +Specifies the representation type name. + + + + +value_names + +Specifies a pointer to an array of value names associated with the +representation type. A value name is specified in lowercase characters +without an Xm prefix. Words within a name are separated with +underscores. + + + + +values + +Specifies a pointer to an array of values associated with the +representation type. A value in this array is associated with +the value name in the corresponding position of the value_names +array. + + + + +num_values + +Specifies the number of entries in the value_names and +values arrays. + + + + + + +RETURN +Returns the identification number for the specified representation +type. + + + +RELATED +&cdeman.XmRepTypeAddReverse;, +&cdeman.XmRepTypeGetId;, +&cdeman.XmRepTypeGetNameList;, +&cdeman.XmRepTypeGetRecord;, +&cdeman.XmRepTypeGetRegistered;, and +&cdeman.XmRepTypeValidValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypVa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypVa.sgm new file mode 100644 index 00000000..beb0382c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RepTypVa.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmRepTypeValidValue +library call + + +XmRepTypeValidValue +A representation type manager function that +tests the validity of a numerical value of a representation type resource + +XmRepTypeValidValue + +representation type manager functions +XmRepTypeValidValue + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RepType.h> + +Boolean XmRepTypeValidValue + +XmRepTypeId rep_type_id +unsigned char test_value +Widget enable_default_warning + + + +DESCRIPTION +XmRepTypeValidValue tests the validity of a numerical +value for a given representation type resource. The function +generates a default warning message if the value is invalid +and the enable_default_warning argument is non-NULL. + + + +rep_type_id + +Specifies the identification number of the representation +type. + + + + +test_value + +Specifies the numerical value to test. + + + + +enable_default_warning + +Specifies the ID of the widget that contains a default warning +message. If this parameter is NULL, +no default warning message is generated and +the application must provide its own error handling. + + + + + + +RETURN +Returns True if the specified value is valid; otherwise, returns False. + + + +RELATED +&cdeman.XmRepTypeGetId; and +&cdeman.XmRepTypeRegister;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveA.sgm new file mode 100644 index 00000000..a0617612 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveA.sgm @@ -0,0 +1,240 @@ + + + + + + + + + + + +XmResolveAllPartOffsets +library call + + +XmResolveAllPartOffsets +A function that allows writing of upward-compatible applications and widgets + +XmResolveAllPartOffsets + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmResolveAllPartOffsets + +WidgetClass widget_class +XmOffsetPtr * offset +XmOffsetPtr * constraint_offset + + + +DESCRIPTION + +XmeResolvePartOffsets instead. +]]> + + +The use of offset records requires two extra global variables per widget +class. +The variables consist of pointers to arrays of offsets into the +widget record and constraint record for each part of the widget +structure. +The XmResolveAllPartOffsets function +allocates the offset records needed by an application to guarantee +upward-compatible access to widget instance and constraint records by +applications and widgets. +These offset records are used by the widget to access all of the +widget's variables. +A widget needs to take the steps described in the following paragraphs. + +Instead of creating a resource list, the widget creates an offset +resource list. +To accomplish this, use the XmPartResource +structure and the XmPartOffset macro. +The XmPartResource data structure looks just like a +resource list, but instead of having +one integer for its offset, it has two shorts. +This structure is put into the class record as if it were a normal resource +list. Instead of using XtOffset for the offset, the widget uses +XmPartOffset. + +If the widget is a subclass of the Constraint class and it defines +additional constraint resources, create an offset resource list for +the constraint part as well. +Instead of using XtOffset for the offset, +the widget uses XmConstraintPartOffset in the constraint resource +list. + + +XmPartResource resources[] = { + { BarNxyz, BarCXyz, XmRBoolean, sizeof(Boolean), + XmPartOffset(Bar,xyz), XmRImmediate, (XtPointer)False } }; +XmPartResource constraints[] = { + { BarNmaxWidth, BarNMaxWidth, + XmRDimension, sizeof(Dimension), + XmConstraintPartOffset(Bar,max_width), + XmRImmediate, (XtPointer)100 } }; + + +Instead of putting the widget size in the class record, the widget puts the +widget part size in the same field. +If the widget is a subclass of +the Constraint class, instead of putting the widget constraint record +size in the class record, the widget puts the widget constraint part size +in the same field. + +Instead of putting XtVersion in the class record, the widget puts +XtVersionDontCheck in the class record. + +Define a variable, of type XmOffsetPtr, to point to +the offset record. +If the widget is a subclass of the Constraint class, define a variable +of type XmOffsetPtr to point to the constraint offset record. +These can be part of the widget's class record or separate global +variables. + +In class initialization, the widget calls XmResolveAllPartOffsets, +passing it pointers to the class record, the address of the offset +record, and the address of the constraint offset record. +If the widget not is a subclass of the Constraint class, it should pass +NULL as the address of the constraint offset record. +This does several things: + + + +Adds the superclass (which, by definition, has already been initialized) +size field to the part size field + + + +If the widget is a subclass of the Constraint class, adds the superclass +constraint size field to the constraint size field + + + +Allocates an array based upon the number of superclasses + + + +If the widget is a subclass of the constraint class, allocates an array +for the constraint offset record + + + +Fills in the offsets of all the widget parts and constraint parts with +the appropriate values, determined by examining the size fields of all +superclass records + + + +Uses the part offset array to modify the offset entries in the resource +list to be real offsets, in place + + + +The widget defines a constant that will be the index to its part +structure in the offsets array. +The value should be 1 greater than +the index of the widget's superclass. +Constants defined for all Xm +widgets can be found in XmP.h. + + +&npzwc;#define BarIndex (XmBulletinBIndex + 1) + + +Instead of accessing fields directly, the widget must always go through +the offset table. +The XmField and XmConstraintField macros help you access +these fields. +Because the XmPartOffset, XmConstraintPartOffset, +XmField, and XmConstraintField +macros concatenate things, you must ensure that there is no space +after the part argument. +For example, the following macros do not work because of the space +after the part (Label) argument: + + +XmField(w, offset, Label, text, char *) +XmPartOffset(Label, text). + + +Therefore, you must not have any spaces after the part (Label) +argument, as illustrated here: + + +XmField(w, offset, Label, text, char *) + + +You can define macros for each field to make this easier. +Assume an integer field xyz: + + +&npzwc;#define BarXyz(w) (*(int *)(((char *) w) + \ + offset[BarIndex] + XtOffset(BarPart,xyz))) + + +For constraint field max_width: + + +&npzwc;#define BarMaxWidth(w) \ + XmConstraintField(w,constraint_offsets,Bar,max_width,Dimension) + + +The parameters for XmResolveAllPartOffsets are + + + +widget_class + +Specifies the widget class pointer for the created widget + + + + +offset + +Returns the offset record + + + + +constraint_offset + +Returns the constraint offset record + + + + + + +RELATED INFORMATION +&cdeman.XmResolvePartOffsets;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveP.sgm new file mode 100644 index 00000000..7f6c5218 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ResolveP.sgm @@ -0,0 +1,189 @@ + + + + + + + + + + + +XmResolvePartOffsets +library call + + +XmResolvePartOffsets +A function that allows writing of upward-compatible applications and widgets + +XmResolvePartOffsets + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmResolvePartOffsets + +WidgetClass widget_class +XmOffsetPtr * offset + + + +DESCRIPTION +The use of offset records requires one extra global variable per widget +class. +The variable consists of a pointer to an array of offsets into the +widget record for each part of the widget structure. +The XmResolvePartOffsets function +allocates the offset records needed by an application to guarantee +upward-compatible access to widget instance records by +applications and widgets. +These offset records are used by the widget to access all of the +widget's variables. +A widget needs to take the steps described in the following paragraphs. + +Instead of creating a resource list, the widget creates an offset +resource list. +To accomplish this, use the XmPartResource +structure and the XmPartOffset macro. +The XmPartResource data structure looks just like a +resource list, but instead of having +one integer for its offset, it has two shorts. +This structure is put into the class record as if it were a normal resource +list. Instead of using XtOffset for the offset, the widget uses +XmPartOffset. + + +XmPartResource resources[] = { + { BarNxyz, BarCXyz, XmRBoolean, + sizeof(Boolean), XmPartOffset(Bar,xyz), + XmRImmediate, (XtPointer)False } +}; + + +Instead of putting the widget size in the class record, the widget puts the +widget part size in the same field. + +Instead of putting XtVersion in the class record, the widget puts +XtVersionDontCheck in the class record. + +The widget defines a variable, of type XmOffsetPtr, to point to +the offset record. +This can be part of the widget's class record or a separate global +variable. + +In class initialization, the widget calls XmResolvePartOffsets, +passing it a pointer to contain the address of the offset +record and the class record. +This does several things: + + + +Adds the superclass (which, by definition, has already been initialized) +size field to the part size field + + + +Allocates an array based upon the number of superclasses + + + +Fills in the offsets of all the widget parts with the appropriate +values, determined by examining the size fields of all superclass +records + + + +Uses the part offset array to modify the offset entries in the resource +list to be real offsets, in place + + + +The widget defines a constant that will be the index to its part +structure in the offsets array. +The value should be 1 greater than +the index of the widget's superclass. +Constants defined for all Xm +widgets can be found in XmP.h. + + +&npzwc;#define BarIndex (XmBulletinBIndex + 1) + + +Instead of accessing fields directly, the widget must always go through +the offset table. +The XmField macro helps you access these fields. +Because the XmPartOffset and XmField +macros concatenate things together, you must +ensure that there is no space +after the part argument. +For example, the following macros do not work because of the space +after the part (Label) argument: + + +XmField(w, offset, Label, text, char *) +XmPartOffset(Label, text) + + +Therefore, you must not have any spaces after the part (Label) +argument, as illustrated here: + + +XmField(w, offset, Label, text, char *) + + +You can define macros for each field to make this easier. +Assume an integer field xyz: + + +&npzwc;#define BarXyz(w) (*(int *)(((char *) w) + \ + offset[BarIndex] + XtOffset(BarPart,xyz))) + + +The parameters for XmResolvePartOffsets are + + + +widget_class + +Specifies the widget class pointer for the created widget + + + + +offset + +Returns the offset record + + + + + + +RELATED INFORMATION +&cdeman.XmResolveAllPartOffsets;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RowCol.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RowCol.sgm new file mode 100644 index 00000000..a4c1d2cf --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/RowCol.sgm @@ -0,0 +1,2507 @@ + + + + + + + + + + + +XmRowColumn +library call + + +XmRowColumn +The RowColumn widget class + +XmRowColumn + +widget class +RowColumn + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/RowColumn.h> + + + +DESCRIPTION +The RowColumn widget is a general purpose RowColumn manager capable +of containing any widget type as a child. +In general, it requires no special +knowledge about how its children function and provides nothing +beyond support for several different layout styles. However, it can be +configured as a menu, in which case, it expects only certain children, and +it configures to a particular layout. The menus supported are MenuBar, +Pulldown or Popup menu panes, and OptionMenu. +RowColumn uses the XmQTmenuSavvy trait and holds the +XmQTmenuSystem trait. + +The type of layout performed is controlled by how the application has set +the various layout resources. +It can be configured to lay out its children in either rows or +columns. In addition, the application can specify how the children are +laid out, as follows: + + + +The children are packed tightly together into either rows or columns + + + +Each child is placed in an identically sized +box (producing a symmetrical look) + + + +A specific layout (the current x and y positions of the children +control their location) + + + +In addition, the application has control over both the spacing that +occurs between each row and column and the margin spacing +present between the edges of the RowColumn widget and any children +that are placed against it. + +The default XmNinsertPosition procedure for the RowColumn +returns the value of XmNpositionIndex if one has been specified +for the child. Otherwise, this procedure returns the number of +children in the RowColumn's XmNnumChildren list. +In a MenuBar, Pulldown menu pane, or Popup menu pane the default for the +XmNshadowThickness resource is 2. +In an OptionMenu or a WorkArea, (such as a RadioBox or CheckBox) this +resource is not applicable and its use is undefined. +If an application wishes to place a 3-D shadow around an OptionMenu or +WorkArea, it can create the RowColumn as a child of a Frame widget. + +In a MenuBar, Pulldown menu pane, or Popup menu pane the +XmNnavigationType resource is not applicable and its use is +undefined. +In a WorkArea, the default for XmNnavigationType is +XmTAB_GROUP. +In an OptionMenu the default for XmNnavigationType is +XmNONE. + +In a MenuBar, Pulldown menu pane, or Popup menu pane the +XmNtraversalOn resource is not applicable and its use is +undefined. +In an OptionMenu or WorkArea, the default for XmNtraversalOn is +True. + +If the parent of the RowColumn is a MenuShell, the +XmNmappedWhenManaged resource is forced to False when the widget +is realized. + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. The following list +identifies the names of these widgets (or gadgets) and the associated +OptionMenu areas. + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + +For the Popup and Pulldown Menupanes, popup and pulldown menus have +particular behaviors when the +Btn1 button is pressed outside the menus. These behaviors +are summarized here. + +When there is already a popped up menu, a user can either press +Btn1 in the same area as the +popped up menu, or can press Btn1 in another area that should +have a menu popped up. When Btn1 is pressed in the same +area as the already popped up menu, that menu is unposted. +If Btn1 is pressed in a different area, +the associated popup menu is posted for the new area. Note, however, +that if the +XmNpopupHandlerCallback of either XmManager or +XmPrimitive is available, then the callback may override these +default behaviors. + +For pulldown menus, a user can press Btn1 on the +Cascade button to post the pulldown menu, then click on it again. Upon the +second click, the pulldown menu is unposted. + +Popup menus are not allowed to have NULL parents. + + +Tear-off Menus +Pulldown and Popup menu panes support tear-off menus, which enable the +user to retain a menu pane on the display to facilitate subsequent +menu selections. A menu pane that can be torn-off is identified by +a tear-off button that spans the width of the menu pane and displays +a dashed line. A torn-off menu pane contains a window manager system +menu icon and a title bar. The window title displays the label of the +cascade button that initiated the action when the label type is +XmSTRING. If the label contains a pixmap the window title is +empty. A tear-off menu from a Popup menu pane also displays +an empty title. +Tear-off menus should not be shared. + +The user can tear off a menu pane using the mouse or keyboard. +Clicking Btn1 or pressing osfActivate (or osfSelect) +on the tear-off button, tears off the menu pane at the current +position. Pressing Btn2 on the tear-off button tears off the +menu pane and allows the user to drag the torn-off menu to a new +position designated by releasing the mouse button. Tearing off a +menu pane unposts the current active menu. Only one tear-off copy +for each menu pane is allowed. Subsequent tear-off actions of a +torn menu pane unpost the existing copy first. + +The name of the tear-off button of a torn-off menu pane is +TearOffControl. The name can be used to set resources in a resource +file. An application can also obtain the tear-off button itself using +XmGetTearOffControl and then set resource values by calling +XtSetValues. + +The tear-off button has Separator-like behavior. Its appearance can be +specified with the following tear-off button resources: +XmNbackground, XmNbackgroundPixmap, +XmNbottomShadowColor, XmNforeground, XmNheight, +XmNmargin, XmNseparatorType, XmNshadowThickness, and +XmNtopShadowColor. Refer to the XmSeparator reference +page for a complete description of each of these resources. + +The XmNtearOffModel, XmNtearOffMenuActivateCallback, and +XmNtearOffMenuDeactivateCallback +are RowColumn resources that affect tear-off menu behavior. +The XmNtearOffTitle resource enables the application to specify +the tear-off menu's title if the menu is torn off. + +By default, menus do not tear off. Setting the +XmNtearOffModel resource to XmTEAR_OFF_ENABLED +enables tear-off functionality. +There is no resource converter +preregistered for XmNtearOffModel. To allow tear-off +functionality to be enabled through the resource database, call the +function XmRepTypeInstallTearOffModelConverter. + +Tear-off menu focus policy follows standard window +manager policy. It is recommended that the +startupKeyFocus and autoKeyFocus +mwm resources be set to True. + + + +Descendants +RowColumn automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +OptionButton +XmCascadeButtonGadget +option menu button + + +OptionLabel +XmLabelGadget +option menu label + + +TearOffControl +subclass of XmPrimitive +tear-off button of torn-off menu pane + + + + + + +Classes +RowColumn inherits behavior, resources, and traits from Core, +Composite, +Constraint, and XmManager classes. + +The class pointer is xmRowColumnWidgetClass. + +The class name is XmRowColumn. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmRowColumn Resource Set + + +Name +Class +Type +Default +Access + + +XmNadjustLast +XmCAdjustLast +Boolean +True +CSG + + +XmNadjustMargin +XmCAdjustMargin +Boolean +True +CSG + + +XmNentryAlignment +XmCAlignment +unsigned char +XmALIGNMENT_BEGINNING +CSG + + +XmNentryBorder +XmCEntryBorder +Dimension +0 +CSG + + +XmNentryCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNentryClass +XmCEntryClass +WidgetClass +dynamic +CSG + + +XmNentryVerticalAlignment +XmCVerticalAlignment +unsigned char +XmALIGNMENT_CENTER +CSG + + +XmNisAligned +XmCIsAligned +Boolean +True +CSG + + +XmNisHomogeneous +XmCIsHomogeneous +Boolean +dynamic +CG + + +XmNlabelString +XmCXmString +XmString +NULL +C + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +dynamic +CSG + + +XmNmenuAccelerator +XmCAccelerators +String +dynamic +CSG + + +XmNmenuHelpWidget +XmCMenuWidget +Widget +NULL +CSG + + +XmNmenuHistory +XmCMenuWidget +Widget +NULL +CSG + + +XmNmenuPost +XmCMenuPost +String +NULL +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +CSG + + +XmNnumColumns +XmCNumColumns +short +1 +CSG + + +XmNorientation +XmCOrientation +unsigned char +dynamic +CSG + + +XmNpacking +XmCPacking +unsigned char +dynamic +CSG + + +XmNpopupEnabled +XmCPopupEnabled +int +XmPOPUP_KEYBOARD +CSG + + +XmNradioAlwaysOne +XmCRadioAlwaysOne +Boolean +True +CSG + + +XmNradioBehavior +XmCRadioBehavior +Boolean +False +CSG + + +XmNresizeHeight +XmCResizeHeight +Boolean +True +CSG + + +XmNresizeWidth +XmCResizeWidth +Boolean +True +CSG + + +XmNrowColumnType +XmCRowColumnType +unsigned char +XmWORK_AREA +CG + + + +XmNspacing +XmCSpacing +Dimension +dynamic +CSG + + +XmNsubMenuId +XmCMenuWidget +Widget +NULL +CSG + + +XmNtearOffMenuActivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNtearOffMenuDeactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNtearOffModel +XmCTearOffModel +unsigned char +XmTEAR_OFF_DISABLED +CSG + + +XmNtearOffTitle +XmCTearOffTitle +XmString +NULL +CSG + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNwhichButton +XmCWhichButton +unsigned int +dynamic +CSG + + + + + + +XmNadjustLast + +Extends the last row of children to the bottom edge of RowColumn (when +XmNorientation is XmHORIZONTAL) or extends the last column to the +right edge of RowColumn (when XmNorientation is XmVERTICAL). +Setting XmNadjustLast to False disables this feature. + + + + +XmNadjustMargin + +Specifies whether the inner minor margins of all +items contained within the RowColumn widget are +forced to the same value. The inner minor margin +corresponds to the XmNmarginLeft, XmNmarginRight, +XmNmarginTop, +and XmNmarginBottom resources supported by XmLabel and +XmLabelGadget. + +A horizontal orientation causes XmNmarginTop and +XmNmarginBottom for all items in a particular row to be forced to the +same value; the value is the largest margin specified +for one of the Label items. + +A vertical orientation causes +XmNmarginLeft and XmNmarginRight for all items in a particular +column to be forced to the same value; the value is the largest +margin specified for one of the Label items. + +This keeps all text within each row or column +lined up with all other text in its row or column. +If XmNrowColumnType is either XmMENU_POPUP or +XmMENU_PULLDOWN and this resource is True, only button children +have their margins adjusted. + + + + +XmNentryAlignment + +Specifies the alignment type for children that are subclasses of +XmLabel or XmLabelGadget when XmNisAligned is enabled. +The following are textual alignment types: + + + +XmALIGNMENT_BEGINNING (default) + + + +XmALIGNMENT_CENTER + + + +XmALIGNMENT_END + + + +See the description of XmNalignment in the &cdeman.XmLabel; +reference page for an explanation of these actions. + + + + +XmNentryBorder + +Imposes a uniform border width upon all RowColumn's children. +The default value is 0 (zero), which disables the feature. + + + + +XmNentryCallback + +Disables the XmNactivateCallback and XmNvalueChangedCallback +callbacks for all CascadeButton, DrawnButton, PushButton, and +ToggleButton widgets and gadgets contained within the RowColumn widget. +If the application supplies this resource, the XmNactivateCallback +and XmNvalueChangedCallback callbacks are then revectored to the +XmNentryCallback callbacks. +This allows an application to supply a single callback routine for +handling all items contained in a RowColumn widget. +The callback reason is XmCR_ACTIVATE. +If the application does not supply this resource, the +XmNactivateCallback and XmNvalueChangedCallback +callbacks for each item in the RowColumn widget work as normal. + +The application must supply this resource when this widget is created. +Changing this resource using the XtSetValues is not +supported. + + + + +XmNentryClass + +Specifies the only widget class that can be added +to the RowColumn widget; this resource is meaningful only when the +XmNisHomogeneous resource is set to True. +Both widget and gadget variants of the specified class may be added to +the widget. + +When XmCreateRadioBox is called or when XmNrowColumnType is +set to XmWORK_AREA and XmNradioBehavior is True, the default +value of XmNentryClass is +xmToggleButtonGadgetClass. +When XmNrowColumnType is set to XmMENU_BAR, the value of +XmNentryClass is forced to xmCascadeButtonWidgetClass. + + + + +XmNentryVerticalAlignment + +Specifies the type of vertical alignment for children that are +subclasses of XmLabel, XmLabelGadget, and XmText. +This resource is invalid if XmNorientation is XmVERTICAL +and XmNpacking is XmPACK_TIGHT, because this layout +preserves variable heights among the children. The vertical alignment +types include: + + + +XmALIGNMENT_BASELINE_BOTTOM + +Causes the bottom baseline of all +children in a row to be aligned. +This resource is applicable only when all children in a row +contain textual data. + + + + +XmALIGNMENT_BASELINE_TOP + +Causes the top baseline of all +children in a row to be aligned. +This resource is applicable only when all children in a +row contain textual data. + + + + +XmALIGNMENT_CONTENTS_BOTTOM + +Causes the bottom of the +contents (text or +pixmap) of all children in a row to be aligned. + + + + +XmALIGNMENT_CENTER + +Causes the center of all children in a row to be +aligned. + + + + +XmALIGNMENT_CONTENTS_TOP + +Causes the top of the contents (text or +pixmap) of all children in a row to be aligned. + + + + + + + +XmNisAligned + +Specifies text alignment for each item within the RowColumn widget; +this applies only to items that are subclasses of +XmLabel or XmLabelGadget. +However, if the item is a Label widget or gadget and its parent is either +a Popup menu pane or a Pulldown menu pane, alignment is not +performed; the Label is treated as the +title within the +menu pane, and the alignment +set by the application is not overridden. +XmNentryAlignment controls the type of textual alignment. + + + + +XmNisHomogeneous + +Indicates whether the RowColumn +widget should enforce exact homogeneity among the items +it contains; if this resource is set to True, only the widgets that are +of the class indicated by XmNentryClass +are allowed as children of the RowColumn widget. +This is most often used when creating a MenuBar. +Attempting to insert a child that is not a member of the +specified class generates a warning message. + +In a MenuBar, the value of XmNisHomogeneous is forced to True. +In an OptionMenu, the value is forced to False. +When XmCreateRadioBox is called the default value is True. +Otherwise, the default value is False. + + + + +XmNlabelString + +When XmNrowColumnType is set to XmMENU_OPTION, +this resource points to a text string that displays the label with +respect to the selection area. The positioning of the label relative to the +selection area depends on the layout +direction in the horizontal orientation. +This resource is not meaningful for all other RowColumn types. +If the application wishes to change the label after creation, it must get the +LabelGadget ID (XmOptionLabelGadget) and call XtSetValues on the +LabelGadget directly. The default value is no label. + + + + +XmNmapCallback + +Specifies a widget-specific callback function that is +invoked when the window associated with the RowColumn widget +is about to be mapped. The callback reason is XmCR_MAP. + + + + +XmNmarginHeight + +Specifies the amount of blank space between the top +edge of the RowColumn widget and the first item in each column, +and the bottom edge of the RowColumn widget and the last item +in each column. +The default value is 0 (zero) for Pulldown and Popup menu panes, and 3 +pixels for other RowColumn types. + + + + +XmNmarginWidth + +Specifies the amount of blank space between the left +edge of the RowColumn widget and the first item in each row, +and the right edge of the RowColumn widget and the last item in +each row. +The default value is 0 (zero) for Pulldown and Popup menu panes, and 3 +pixels for other RowColumn types. + + + + +XmNmenuAccelerator + +This resource is useful only when the RowColumn widget has been configured +to operate as a Popup menu pane or a MenuBar. +The format of this resource is similar to the left side specification +of a translation string, with the limitation that it must specify a key +event. +For a Popup menu pane, when the accelerator is typed by the user, the Popup +menu pane is posted. +For a MenuBar, when the accelerator is typed by the user, the first item +in the MenuBar is highlighted, and traversal is enabled in the +MenuBar. +The default for a Popup menu pane is osfMenu. +The default for a MenuBar is osfMenuBar. +Setting the XmNpopupEnabled resource to False disables +the accelerator. + + + + +XmNmenuHelpWidget + +Specifies the widget ID for the CascadeButton, which is treated as +the Help widget if XmNrowColumnType is set to XmMENU_BAR. +Which corner of the MenuBar the Help widget is placed at depends on +the XmNlayoutDirection resource of the widget. +If the RowColumn widget is any type other than XmMENU_BAR, +this resource is not meaningful. + + + + +XmNmenuHistory + +Specifies the widget ID of the last menu entry to be activated. It is +also useful for specifying the current selection for an OptionMenu. If +XmNrowColumnType is set to XmMENU_OPTION, the specified +menu item is positioned under the cursor when the menu is displayed. + +If the RowColumn widget has the XmNradioBehavior resource set to +True, +the widget field associated with this resource +contains the widget ID of the last ToggleButton or ToggleButtonGadget +to change from unselected to selected. +The default value is the widget ID of the first child in +the widget. + + + + +XmNmenuPost + +Specifies an X event description indicating a button event that posts a menu +system. +The default for XmMENU_POPUP is BMenu Press. +The default for XmMENU_OPTION, XmMENU_BAR, and +XmWORK_AREA is Btn1 Press. +The XmNmenuPost resource for pulldowns should be consistent with that of +the top-level parent menu (although the event type is ignored). +Setting this resource to BTransfer Press will conflict with drag and drop +operations, which use BTransfer Press as a default button binding. +Therefore, this resource cannot be BTransfer Press. + + + + +XmNmnemonic + +This resource is useful only when XmNrowColumnType is +set to XmMENU_OPTION. +It specifies a keysym for a key that, when pressed by the user along with +the MAlt modifier, posts +the associated Pulldown menu pane. +The first character in the OptionMenu label string that exactly matches +the mnemonic in the character set specified in XmNmnemonicCharSet +is underlined. +The user can post the menu by pressing either the shifted or the +unshifted mnemonic key. +The default is no mnemonic. + + + + +XmNmnemonicCharSet + +Specifies the character set of the mnemonic for an OptionMenu. +The default is XmFONTLIST_DEFAULT_TAG. +If the RowColumn widget is any type other than XmMENU_OPTION, +this resource is not meaningful. + + + + +XmNnumColumns + +Specifies the number of minor dimension extensions +that are made to accommodate the entries; this +attribute is meaningful only when XmNpacking is set to +XmPACK_COLUMN. + +For vertically oriented RowColumn widgets, this attribute +indicates how many columns are built; the number of +entries per column is adjusted to maintain this +number of columns, if possible. + +For horizontally oriented RowColumn widgets, this attribute +indicates how many rows are built. + +The default value is 1. +In an OptionMenu the value is forced to 1. +The value must be greater than 0 (zero). + + + + +XmNorientation + +Determines whether RowColumn layouts are row-major or column-major. +In a column-major layout, the children of the RowColumn +are laid out in +columns within the widget. In a row-major layout the children of +the RowColumn are laid out in rows. The direction of the horizontal +layout in the row-major layout (from left or right), and the wrapping in +the column-major layout (vertical), depend on the +XmNlayoutDirection resource of the widget. +The XmVERTICAL resource value +selects a column-major layout. +XmHORIZONTAL selects a row-major layout. + +When creating a MenuBar or an OptionMenu, the default is +XmHORIZONTAL. +Otherwise, the default value is XmVERTICAL. +The results of specifying a value of XmVERTICAL for a MenuBar are +undefined. + + + + +XmNpacking + +Specifies how to pack the items contained within a +RowColumn widget. This can be set to XmPACK_TIGHT, XmPACK_COLUMN or XmPACK_NONE. When a RowColumn widget +packs the items it contains, it determines its major +dimension using the value of the XmNorientation resource. + +XmPACK_TIGHT indicates that given the current major +dimension (for example, vertical if XmNorientation is XmVERTICAL), entries +are placed one after the other until +the RowColumn widget must wrap. RowColumn wraps when there is no room left +for a complete child in that dimension. +Wrapping occurs +by beginning a new row or column in the next available +space. Wrapping continues, as often as necessary, until +all of the children are laid out. +In the vertical dimension (columns), boxes are set to the same width; in the +horizontal dimension (rows), boxes are set to the same depth. +Each +entry's position in the major dimension is left unaltered (for example, +XmNy is left unchanged when XmNorientation is XmVERTICAL); its +position in the minor +dimension is set to the same value as the greatest entry +in that particular row or column. The position in the minor +dimension of any particular row or column is independent +of all other rows or columns. + +XmPACK_COLUMN indicates that all entries are placed in +identically sized boxes. The boxes are based on the largest height +and width values of all the children widgets. +The value of the XmNnumColumns +resource determines how many boxes are placed in the +major dimension, before extending in the minor dimension. + +XmPACK_NONE indicates that no packing is performed. +The x and y attributes of each entry are left alone, and +the RowColumn widget attempts to become large enough to enclose all +entries. + +When XmCreateRadioBox is called or when XmNrowColumnType +is set to XmWORK_AREA and XmNradioBehavior is True, the +default value of XmNpacking is XmPACK_COLUMN. +In an OptionMenu the value is initialized to XmPACK_TIGHT. +Otherwise, the value defaults to XmPACK_TIGHT. + + + + +XmNpopupEnabled + +Allows the menu system +to enable keyboard input (accelerators and mnemonics) defined for the Popup +menu pane and any of its submenus. +The Popup menu pane needs to be informed whenever its accessibility to the user +changes because posting of the Popup menu pane is controlled by the +application. +This resource can take four values, including: + + + +XmPOPUP_KEYBOARD + +Specifies that the keyboard +input—accelerators and mnemonics—defined for the Popup menu pane +and any of its submenus is enabled. This is the default. + + + + +XmPOPUP_DISABLED + +Specifies that the keyboard input is disabled. + + + + +XmPOPUP_AUTOMATIC + +Specifies that the keyboard is enabled for automatic popup menus. + + + + +XmPOPUP_AUTOMATIC_RECURSIVE + +Specifies that the keyboard is enabled for recursive automatic popup menus. + + + + + + + + + + + + + + + + + + + + + +XmNradioAlwaysOne + +If True, forces the active ToggleButton or ToggleButtonGadget +to be automatically selected after having +been unselected (if no other toggle was activated). +If False, the active toggle may be unselected. +The default value is True. This resource is important only when +XmNradioBehavior is True. + +The application can always add and subtract toggles from +RowColumn regardless of the selected/unselected state of the toggle. The +application can also manage and unmanage toggle +children of RowColumn at any time regardless of state. Therefore, +the application can sometimes +create a RowColumn that has XmNradioAlwaysOne set to +True and none +of the toggle children selected. +The result is undefined if the value of this resource is True and the +application sets more than one ToggleButton at a time. + + + + +XmNradioBehavior + +Specifies a Boolean value that when True, indicates +that the RowColumn widget should enforce a RadioBox-type behavior +on all of its children that are ToggleButtons or +ToggleButtonGadgets. + +When the value of this resource is True, +XmNindicatorType defaults to XmONE_OF_MANY +for ToggleButton and ToggleButtonGadget children. + +RadioBox +behavior dictates that when one toggle is selected and the user selects another +toggle, the first toggle is unselected +automatically. +The RowColumn usually does not enforce this behavior if the application, +rather than the user, changes the state of a toggle. +The RowColumn does enforce this behavior if a toggle child is selected +with XmToggleButtonSetState or XmToggleButtonGadgetSetState +with a notify argument of True. + +When XmCreateRadioBox is called, the default value of +XmNradioBehavior is True. +Otherwise, the default value is False. + + + + +XmNresizeHeight + +Requests a new height if necessary, when set to True. When this +resource is set to +False, the widget does not request a new height regardless of any +changes to the widget or its children. + + + + +XmNresizeWidth + +Requests a new width if necessary, when set to True. When set to +False, the widget does not request a new width regardless of any +changes to the widget or its children. + + + + +XmNrowColumnType + +Specifies the type of RowColumn widget +to be created. +It is a nonstandard resource that cannot be changed after it is set. +If an application uses any of the +convenience routines, except XmCreateRowColumn, +this resource is automatically forced to the appropriate +value by the convenience routine. If an application uses +the Xt Intrinsics API to create its RowColumn widgets, +it must specify this resource itself. The set +of possible settings for this resource are + + + +XmWORK_AREA (default) + + + +XmMENU_BAR + + + +XmMENU_PULLDOWN + + + +XmMENU_POPUP + + + +XmMENU_OPTION + + + +This resource cannot be changed after the RowColumn widget +is created. Any changes attempted through XtSetValues +are ignored. + +The value of this resource is used to determine the value of a number +of other resources. The descriptions of RowColumn resources explain +this when it is the case. The resource XmNnavigationType, +inherited from XmManager, is changed to XmNONE if +XmNrowColumnType is XmMENU_OPTION. + + + + +XmNspacing + +Specifies the horizontal and vertical spacing between +items contained within the RowColumn widget. +The default value is 3 pixels for XmOPTION_MENU and +XmWORK_AREA and 0 (zero) for other RowColumn types. + + + + +XmNsubMenuId + +Specifies the widget ID for the Pulldown menu pane to be associated with +an OptionMenu. This resource is useful only when XmNrowColumnType is +set to XmMENU_OPTION. +The default value is NULL. + + + + +XmNtearOffMenuActivateCallback + +Specifies the callback list that notifies the application when +the tear-off menu pane is about to be activated. It precedes the tear-off's +map callback. + +Use this resource when your application has shared menu panes and when +the torn-off menu can have two or +more parents that can have opposing sensitivity states for the same +menu item. +This resource enables +the application to track +whether a menu item is sensitive or insensitive and to set the state to the +original parent's menu item state when the torn-off menu is reposted. +The application can use XmGetPostedFromWidget to determine from which +parent the menu was torn. The callback reason is XmCR_TEAR_OFF_ACTIVATE. +The default is NULL. + + + + +XmNtearOffMenuDeactivateCallback + +Specifies the callback list that notifies the application when +the tear-off menu pane is about to be deactivated. It follows the tear-off's +unmap callback. + +Use this resource when your application has shared menu panes and when +the torn-off menu can have two or +more parents that can have opposing sensitivity states for the same +menu item. +This resource enables +the application to track +whether a menu item is sensitive or insensitive and to set the state to the +original parent's menu item state when the torn-off menu is reposted. +The application can use XmGetPostedFromWidget to determine from which +parent the menu was torn. +The callback reason is XmCR_TEAR_OFF_DEACTIVATE. The default is NULL. + + + + +XmNtearOffModel + +Indicates whether tear-off functionality is enabled or disabled +when XmNrowColumnType is set to XmMENU_PULLDOWN or +XmMENU_POPUP. The values are XmTEAR_OFF_ENABLED or +XmTEAR_OFF_DISABLED (default value). This resource is +invalid for type XmMENU_OPTION; however, it does affect +any pulldown +submenus within an OptionMenu. +The function XmRepTypeInstallTearOffModelConverter installs +a resource converter for this resource. + + + + +XmNtearoffTitle + +Used by the TearOff shell to set the title for the window manager to +display. + + + + +XmNunmapCallback + +Specifies a list of callbacks that is called +after the window associated with the RowColumn +widget has been unmapped. The callback reason is XmCR_UNMAP. +The default value is NULL. + + + + +XmNwhichButton + +This resource is obsolete; it has been replaced by XmNmenuPost and +is present for compatibility with older releases of Motif. +This resource cannot be 2. + + + + + + + + + + + + + + +XmRowColumn Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNpositionIndex +XmCPositionIndex +short +XmLAST_POSITION +CSG + + + + + + +XmNpositionIndex + +Specifies the position of the widget in its parent's list of +children (the value of the XmNchildren resource). The value +is an integer that is no less than 0 (zero) and no greater than +the number of children in the list at the time the value is +specified. A value of 0 (zero) means that the child is placed at the +beginning of the list. The value can also be specified as +XmLAST_POSITION (the default), which means that the child +is placed at the end of the list. Any other value is ignored. +XtGetValues returns the position of the widget in its parent's +child list at the time of the call to XtGetValues. + +When a widget is inserted into its parent's child list, the positions +of any existing children that are greater than or equal to the +specified widget's XmNpositionIndex are increased by 1. +The effect of a call to XtSetValues for XmNpositionIndex +is to remove the specified widget from its parent's child list, decrease +by 1 the positions of any existing children that are greater than +the specified widget's former position in the list, and then insert +the specified widget into its parent's child list as described in the +preceding sentence. + + + + + + + + + + + + + + +Simple Menu Creation Resource Set + + +Name +Class +Type +Default +Access + + +XmNbuttonAccelerators +XmCButtonAccelerators +StringTable +NULL +C + + +XmNbuttonAcceleratorText +XmCButtonAcceleratorText +XmStringTable +NULL +C + + +XmNbuttonCount +XmCButtonCount +int +0 +C + + +XmNbuttonMnemonicCharSets +XmCButtonMnemonicCharSets +XmStringCharSetTable +NULL +C + + +XmNbuttonMnemonics +XmCButtonMnemonics +XmKeySymTable +NULL +C + + +XmNbuttons +XmCButtons +XmStringTable +NULL +C + + +XmNbuttonSet +XmCButtonSet +int +−1 +C + + +XmNbuttonType +XmCButtonType +XmButtonTypeTable +NULL +C + + +XmNoptionLabel +XmCOptionLabel +XmString +NULL +C + + +XmNoptionMnemonic +XmCOptionMnemonic +KeySym +NULL +C + + +XmNpostFromButton +XmCPostFromButton +int +−1 +C + + +XmNsimpleCallback +XmCCallback +XtCallbackProc +NULL +C + + + + + + + +XmNbuttonAccelerators + +This resource is for use with the simple menu creation routines. +It specifies a list of accelerators for the buttons created. +The list contains one element for each button, separator, and title +created. + + + + +XmNbuttonAcceleratorText + +This resource is for use with the simple menu creation routines. +It specifies a list of compound strings to display for the accelerators for +the buttons created. +The list contains one element for each button, separator, and title +created. + + + + +XmNbuttonCount + +This resource is for use with the simple menu creation routines. +It specifies the total number of menu buttons, separators, and titles to +create. +The value must not be negative. + + + + +XmNbuttonMnemonicCharSets + +This resource is for use with the simple menu creation routines. +It specifies a list of character sets with which button mnemonics are to be +displayed. +The list contains one element for each button, separator, and title +created. +The default is determined dynamically depending on the locale of the +widget. + + + + +XmNbuttonMnemonics + +This resource is for use with the simple menu creation routines. +It specifies a list of mnemonics for the buttons created. +The list contains one element for each button, separator, and title +created. + + + + +XmNbuttons + +This resource is for use with the simple menu creation routines. +It specifies a list of compound strings to use as labels for the buttons +created. +The list contains one element for each button, separator, and title +created. + + + + +XmNbuttonSet + +This resource is for use with the simple menu creation routines. +It specifies which button of a RadioBox or OptionMenu Pulldown submenu +is initially set. +The value is an integer n indicating the nth +ToggleButtonGadget specified for a RadioBox or the nth +PushButtonGadget specified for an OptionMenu Pulldown submenu. +The first button specified is number 0. +The value must not be negative. + + + + +XmNbuttonType + +This resource is for use with the simple menu creation routines. +It specifies a list of button types associated with the buttons to be +created. +The list contains one element for each button, separator, and title +created. +If this resource is not specified, each button in a MenuBar is a +CascadeButtonGadget, each button in a RadioBox or CheckBox is a +ToggleButtonGadget, and +each button in any other type +of RowColumn widget is a PushButtonGadget. +Each button type is of type XmButtonType, an enumeration with the +following possible values: + + + +XmCASCADEBUTTON + +Specifies a CascadeButtonGadget for a MenuBar, +Popup menu pane, or Pulldown menu pane. + + + + +XmCHECKBUTTON + +Specifies a ToggleButtonGadget for a CheckBox, +Popup menu pane, or Pulldown menu pane. + + + + +XmDOUBLE_SEPARATOR + +Specifies a SeparatorGadget for a Popup +menu pane, Pulldown menu pane, or OptionMenu Pulldown submenu. +The separator type is XmDOUBLE_LINE. + + + + +XmPUSHBUTTON + +Specifies a PushButtonGadget for a Popup menu pane, +Pulldown menu pane, or OptionMenu Pulldown submenu. + + + + +XmRADIOBUTTON + +Specifies a ToggleButtonGadget for a RadioBox, +Popup menu pane, or Pulldown menu pane. + + + + +XmSEPARATOR + +Specifies a SeparatorGadget for a Popup menu pane, +Pulldown menu pane, or OptionMenu Pulldown submenu. + + + + +XmTITLE + +Specifies a LabelGadget used as a title for a Popup +menu pane or Pulldown menu pane. + + + + + + + +XmNoptionLabel + +This resource is for use with the simple menu creation routines. +It specifies a compound string for the label string to be used on the left +side of an OptionMenu. + + + + +XmNoptionMnemonic + +This resource is for use with the simple menu creation routines. +It specifies a keysym for a key that, when pressed by the user along +with the MAlt modifier, posts +the associated Pulldown menu pane for an OptionMenu. + + + + +XmNpostFromButton + +This resource is for use with the simple menu creation routines. +For a Pulldown menu pane, it specifies the button in the parent to which +the submenu is attached. +The menu is then posted from this button. +The value is an integer n indicating the nth +CascadeButton or CascadeButtonGadget specified for the parent of the +Pulldown menu pane. +The first button specified is number 0. +The value must not be negative. + + + + +XmNsimpleCallback + +This resource is for use with the simple menu creation routines. +It specifies a callback procedure to be called when a button is +activated or when its value changes. +This callback function is added to each button after creation. +For a CascadeButtonGadget or a PushButtonGadget, the callback is added +as the button's XmNactivateCallback, and it is called when the +button is activated. +For a ToggleButtonGadget, the callback is added as the button's +XmNvalueChangedCallback, and it is called when the button's value +changes. +The button number is passed in the client_data field. + + + + + + + +Inherited Resources +RowColumn inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +dynamic +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +default procedure +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + Widget widget; + char * data; + char * callbackstruct; +} XmRowColumnCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +The following fields apply only when the callback reason is XmCR_ACTIVATE; +for all other callback reasons, these fields are set to NULL. +The XmCR_ACTIVATE callback reason is generated only when the application +has supplied an entry callback, which overrides any activation callbacks +registered with the individual RowColumn items. + + + +widget + +Is set to the widget ID of the RowColumn item that has been activated + + + + +data + +Contains the client-data value supplied by the +application when the RowColumn item's activation callback was registered + + + + +callbackstruct + +Points to the callback structure +generated by the RowColumn item's activation callback + + + + + + + + + + + + + + + + +Translations +XmRowColumn translations depend on the value of +the XmNrowColumnType resource. + +If XmNrowColumnType is set to XmWORK_AREA, +XmRowColumn inherits translations from XmManager. + +If XmNrowColumnType is set to XmMENU_OPTION, +XmRowColumn inherits traversal, osfActivate, and osfCancel +translations from XmManager +and has the following additional translations. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +Btn2Down: + +MenuGadgetDrag() + + + + +c<Btn1Down>: + +MenuGadgetTraverseCurrent() + + + + +c<Btn1Up>: + +MenuGadgetTraverseCurrentUp() + + + + +≈cBtnDown: + +MenuBtnDown() + + + + +≈cBtnUp: + +MenuBtnUp() + + + + +:KeyosfHelp: + +MenuHelp() + + + + + +The translations for XmRowColumn if +XmNrowColumnType is set to XmMENU_BAR +XmMENU_PULLDOWN, or XmMENU_POPUP +are described in the following list. +In a Popup menu system, Btn3 also performs the Btn1 +actions. + + + +:KeyosfHelp: + +MenuHelp() + + + + +:KeyosfLeft: + +MenuGadgetTraverseLeft() + + + + +:KeyosfRight: + +MenuGadgetTraverseRight() + + + + +:KeyosfUp: + +MenuGadgetTraverseUp() + + + + +:KeyosfDown: + +MenuGadgetTraverseDown() + + + + + + + +Action Routines +The XmRowColumn action routines are + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +ManagerGadgetSelect(): + +When a gadget child of the menu has the focus, invokes the gadget +child's behavior associated with osfSelect. +This generally has the effect of unposting the menu hierarchy and arming +and activating the gadget, except that, for a CascadeButtonGadget with a +submenu, it posts the submenu. + + + + +MenuBtnDown(): + +When a gadget child of the menu has focus, invokes the gadget +child's behavior associated with Btn1Down. +This generally has the effect of unposting any menus posted by the +parent menu, enabling mouse traversal in the menu, and arming the +gadget. +For a CascadeButtonGadget with a submenu, it also posts the associated +submenu. + + + + +MenuBtnUp(): + +When a gadget child of the menu has focus, invokes the gadget +child's behavior associated with Btn1Up. +This generally has the effect of unposting the menu hierarchy and +activating the gadget, +except that for a CascadeButtonGadget with a +submenu, it posts the submenu and enables keyboard traversal in the +menu. + + + + +MenuGadgetEscape(): + +In a top-level Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, when the shell's +keyboard focus policy is XmEXPLICIT, restores keyboard focus to +the widget that had the focus before the MenuBar was entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and, when the shell's keyboard +focus policy is XmEXPLICIT, restores keyboard focus to the widget +from which the menu was posted. +In a TearOff MenuPane that has no submenus posted, dismisses the +menu; otherwise, if one or more submenus are posted, unposts the last +menu pane. + + + + +MenuGadgetTraverseDown(): + +If the current menu item has a submenu and is in a MenuBar, then this +action posts the submenu, disarms the current menu item, and arms +the submenu's first traversable menu item. + +If the current menu item is in a MenuPane, then this action disarms the +current menu item and arms the item below it. This action wraps within the +MenuPane. The direction of the wrapping depends on the +XmNlayoutDirection resource. + + + + +MenuGadgetTraverseLeft(): + +When the current menu item is in a MenuBar, this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the left edge of a MenuPane, +this action disarms the current item and arms the item to its left. +If the current menu item is at the left edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the left, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the left edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +left edge, this action wraps within the MenuPane. If the current menu +item is at the left edge of the MenuPane and not in the top row, this +action wraps to the rightmost menu item in the row above. If the current +menu item is in the upper, leftmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +rightmost menu item in the MenuPane. + +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the left +edge of a MenuPane, this action disarms the current item and arms the +item to its left, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the left edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the left. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the left edge of a row (except the +bottom row), this action wraps to the rightmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, leftmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, rightmost menu item of the MenuPane. + + + + +MenuGadgetTraverseRight(): + +If the current menu item is in a MenuBar, then this action disarms the +current item and arms the MenuBar item to the right. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is a CascadeButton, then this +action posts its associated submenu. +If the current menu item is not a CascadeButton and is not at the right +edge of a MenuPane, this action disarms the current item and arms the +item to its right, wrapping if necessary. +If the current menu item is not a CascadeButton and is at the right edge of a +submenu that is a descendent of a MenuBar, then this action unposts all +submenus and traverses to the MenuBar item to the right. +If that MenuBar item has a submenu, it posts the submenu and arms +the submenu's first traversable item. + +In Popup or Torn-off menus, if the current menu item is not a +CascadeButton and is at the right edge of a row (except the +bottom row), this action wraps to the leftmost menu item in the +row below. If the current menu item is not a CascadeButton and +is in the bottom, rightmost corner of a Popup or Pulldown MenuPane, this +action wraps to the tear-off control, if present, or else it wraps to +the top, leftmost menu item of the MenuPane. + +The preceding description applies when the XmNlayoutDirection horizontal +direction is XmLEFT_TO_RIGHT. If the XmNlayoutDirection horizontal +direction is XmRIGHT_TO_LEFT, then the following applies. +When the current menu item is in a MenuBar, this action disarms the +current item and arms the MenuBar item to the left. +This action wraps within the MenuBar. + +In MenuPanes, if the current menu item is not at the right edge of a MenuPane, +this action disarms the current item and arms the item to its right. +If the current menu item is at the right edge of a submenu attached to a +MenuBar item, then this action unposts the submenu and traverses to the +MenuBar item to the right, wrapping if necessary. If that MenuBar item +has a submenu, it posts the submenu and arms the first traversable +item in the submenu. +If the current menu item is at the right edge of a submenu not directly +attached to a MenuBar item, then this action unposts the current submenu only. + +In Popup or Torn-off MenuPanes, when the current menu item is at the +right edge, this action wraps within the MenuPane. If the current menu +item is at the right edge of the MenuPane and not in the top row, this +action wraps to the leftmost menu item in the row above. If the current +menu item is in the upper, rightmost corner, this action wraps +to the tear-off control, if present, or else it wraps to the bottom, +leftmost menu item in the MenuPane. + + + + +MenuGadgetTraverseUp(): + +When the current menu item is in a MenuPane, then +this action disarms the current menu item and arms the item above it. +This action wraps within the MenuPane. The direction of the wrapping +depends on the XmNlayoutDirection resource. + + + + + + +Related Behavior +The following menu functions are available: + + + +osfMenuBar: + +In any non-popup descendant of a MenuBar's parent, excluding the MenuBar +itself, this action enables keyboard traversal and moves keyboard focus +to the first item in the MenuBar. +In the MenuBar or any menu cascaded from it, this action unposts the +menu hierarchy and, when the shell's keyboard focus policy is +XmEXPLICIT, restores focus to the widget that had the focus +when the menu system was entered. + + + + +osfMenu: + +Pops up the menu associated with the control that has the keyboard focus. +Enables keyboard traversal in the menu. +In the Popup menu system or any menu cascaded from it, this action +unposts the menu hierarchy and, when the shell's keyboard focus policy +is XmEXPLICIT, restores focus to the widget that had the focus +when the menu system was entered. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmCreateMenuBar;, +&cdeman.XmCreateOptionMenu;, +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleMenuBar;, +&cdeman.XmCreateSimpleOptionMenu;, +&cdeman.XmCreateSimplePopupMenu;, +&cdeman.XmCreateSimplePulldownMenu;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmCreateWorkArea;, +&cdeman.XmGetMenuCursor;, +&cdeman.XmGetPostedFromWidget;, +XmGetTearOffControl, +&cdeman.XmLabel;, +&cdeman.XmManager;, +&cdeman.XmMenuPosition;, +&cdeman.XmOptionButtonGadget;, +&cdeman.XmOptionLabelGadget;, +XmRepTypeInstallTearOffModelConverter, +&cdeman.XmSetMenuCursor;, +&cdeman.XmUpdateDisplay;, +&cdeman.XmVaCreateSimpleCheckBox;, +&cdeman.XmVaCreateSimpleMenuBar;, +&cdeman.XmVaCreateSimpleOptionMenu;, +&cdeman.XmVaCreateSimplePopupMenu;, +&cdeman.XmVaCreateSimplePulldownMenu;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBox.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBox.sgm new file mode 100644 index 00000000..21f27a18 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBox.sgm @@ -0,0 +1,696 @@ + + + + + + + + + + +XmSimpleSpinBox +library callXmSimpleSpinBoxa simple SpinBox widget class + +#include <Xm/SSpinB.h> + +DESCRIPTION +The XmSimpleSpinBox widget is a user interface control to increment and decrement +an arbitrary TextField. For example, it can be used to cycle through the months +of the year or days of the month. +Widget subclassing is not supported for the XmSimpleSpinBox widget class. + + +Classes +The XmSimpleSpinBox widget inherits behavior and resources from the Core, Composite and XmManager classes. +The class pointer is XmSimpleSpinBoxWidgetClass. + +The class name is XmSimpleSpinBoxWidget. + + + +New Resources +The following table defines a set of widget resources used by the application +to specify data. The application can also set the resource values for the +inherited classes to set attributes for this widget. To reference a resource +by name or by class in a .Xdefaults file, the application +must remove the XmN or XmC prefix and +use the remaining letters. To specify one of the defined values for a resource +in a .Xdefaults file, the application must remove the Xm prefix and use the remaining letters (in either lower case or +upper case, but including any underscores between words). The codes in the +access column indicate if the given resource can be set at creation time (C), +set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmSimpleSpinBox Resource +Set + +Name +Class +Type +Default +Access + +XmNarrowLayout +XmCArrowLayout +unsigned char +XmARROWS_END +CSG + +XmNarrowSensitivity +XmCArrowSensitivity +unsigned char +XmARROWS-_SENSITIVE +CSG + +XmNcolumns +XmCColumn +short +20 +CSG + +XmNdecimalPoints +XmCDecimalPoints +short +0 +CSG + +XmNeditable +XmCEditable +Boolean +True +CSG + +XmNincrementValue +XmCIncrementValue +int +1 +CSG + +XmNinitialDelay +XmCInitialDelay +unsigned int +250 +CSG + +XmNmaximumValue +XmCMaximumValue +int +10 +CSG + +XmNminimumValue +XmCMinimumValue +int +0 +CSG + +XmNmodifyVerifyCallback +XmCCallback +XtCallbackList +NULL +C + +XmNnumValues +XmCNumValues +int +0 +CSG + +XmNposition +XmCPosition +int +0 +CSG + +XmNrepeatDelay +XmCRepeatDelay +unsigned int +200 +CSG + +XmNspinBoxChildType +XmCSpinBoxChildType +unsigned char +XmSTRING +CG + +XmNtextField +XmCTextField +Widget +dynamic +G + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + +XmNvalues +XmCValues +XmStringTable +NULL +CSG + +XmNarrowLayout + +Specifies the style and position of the SpinBox arrows. The following +values are supported: + +XmARROWS_FLAT_BEGINNING + +The arrows are placed side by side to the right of the TextField. + + +XmARROWS_FLAT_END + +The arrows are placed side by side to the left of the TextField. + + +XmARROWS_SPLIT + +The down arrow is on the left and the up arrow is on the right of the +TextField. + + +XmARROWS_BEGINNING + +The arrows are stacked and placed on the left of the TextField. + + +XmARROWS_END + +The arrows are stacked and placed on the right of the TextField. + + + + + +XmNarrowSensitivity + +Specifies the sensitivity of the arrows in the XmSimpleSpinBox. The following +values are supported: + +XmARROWS_SENSITIVE + +Both arrows are active to user selection. + + +XmARROWS_DECREMENT_SENSITIVE + +The down arrow is active and the up arrow is inactive to user selection. + + + +XmARROWS_INCREMENT_SENSITIVE + +The up arrow is active and the down arrow is inactive to user selection. + + + +XmARROWS_INSENSITIVE + +Both arrows are inactive to user selection. + + + + + +XmNcolumns + +Specifies the number of columns of the text field. + + + +XmNdecimalPoints + +Specifies the position of the radix character within the numeric value +when XmNspinBoxChildType is XmNUMERIC. This resource is used to allow for +floating point values in the XmSimpleSpinBox widget. + + +XmNeditable + +Specifies whether the text field can take input. + + +When XmNeditable is used on a widget +it sets the dropsite to XmDROP_SITE_ACTIVE. + + + +XmNincrementValue + +Specifies the amount to increment or decrement the XmNposition when the XmNspinBoxChildType is XmNUMERIC. When +the Up action is activated, the XmNincrementValue is added to the XmNposition +value; when the Down action is activated, the XmNincrementValue is subtracted from the XmNposition value. When XmNspinBoxChildType is XmSTRING, this +resource is ignored. + + +XmNinitialDelay + +Specifies the amount of time in milliseconds before the Arrow buttons +will begin to spin continuously. + + +XmNnumValues + +Specifies the number of items in the XmNvalues list when the XmNspinBoxChildType resource is XmSTRING. +The value of this resource must be a positive integer. The XmNnumValues is maintained by the XmSimpleSpinBox widget when items +are added or deleted from the XmNvalues +list. When XmNspinBoxChildType is +not XmSTRING, this resource is ignored. + + + +XmNvalues + +Supplies the list of strings to cycle through when the XmNspinButtonChildType resource is XmSTRING. +When XmNspinBoxChildType is not XmSTRING, this resource is ignored. + + +XmNmaximumValue + +Specifies the upper bound on the XmSimpleSpinBox's range when XmNspinBoxChildType is XmNUMERIC. + + +XmNminimumValue + +Specifies the lower bound on the XmSimpleSpinBox's range when XmNspinBoxChildType is XmNUMERIC. + + +XmNmodifyVerifyCallback + +Specifies the callback to be invoked just before the XmSimpleSpinBox position +changes. The application can use this callback to implement new application-related +logic (including setting new position spinning to, or canceling the impending +action). For example, this callback can be used to stop the spinning just +before wrapping at the upper and lower position boundaries. If the application +sets the doit member of the XmSimpleSpinBoxCallbackStruct to False, nothing happens. Otherwise, +the position changes. Reasons sent by the callback are XmCR_SPIN_NEXT, or XmCR_SPIN_PRIOR. + + +XmNposition + +The XmNposition resource has +a different value based on the XmNspinBoxChildType resource. When XmNspinBoxChildType is XmSTRING, the XmNposition is the index into the XmNvalues list for the current item. When the XmNspinBoxChildType resource is XmNUMERIC, the XmNposition is the integer value of the XmSimpleSpinBox that falls +within the range of XmNmaximumValue +and XmNminimumValue. + + +XmNrepeatDelay + +Specifies the number of milliseconds between repeated calls to the XmNvalueChangedCallback while the user is spinning +the XmSimpleSpinBox. + + +XmNspinBoxChildType + +Specifies the style of the XmSimpleSpinBox. The following values are supported: + + +XmSTRING + +The child is a string value that is specified through the XmNvalues resource and incremented and decremented +by changing the XmNposition resource. + + + +XmNUMERIC + +The child is a numeric value that is specified through the XmNposition resource and incremented according +to the XmNincrementValue resource. + + + + + + +XmtextField + +Specifies the textfield widget. + + + +XmNvalueChangedCallback + +Specifies the callback to be invoked whenever the value of the XmNposition resource is changed through the +use of the spinner arrows. The XmNvalueChangedCallback passes the XmSimpleSpinBoxCallbackStruct call_data structure. + + + + + +Inherited Resources +The XmSimpleSpinBox widget inherits behavior and resources from the following +named superclasses. For a complete description of each resource, see the for that superclass. + + + + + + + + + + + +XmManager Resource +Set + +Name +Class +Type +Default +Access + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + +XmNnavigationType +XmCNavigationType +XmNavigationType +dynamic +CSG + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + +XmNtraversalOn +XmCTraversalOn +Boolean +dynamic +CSG + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + +Composite Resource +Set + +Name +Class +Type +Default +Access + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +default procedure +CSG + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + +Core Resource Set + +Name +Class +Type +Default +Access + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + +XmNdepth +XmCDepth +int +dynamic +CG + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + +XmNheight +XmCHeight +Dimension +dynamic +CSG + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + +XmNscreen +XmCScreen +Screen * +dynamic +CG + +XmNsensitive +XmCSensitive +Boolean +True +CSG + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + +XmNx +XmCPosition +Position +0 +CSG + +XmNy +XmCPosition +Position +0 +CSG + + +Callback Information +A pointer to the following structure is passed to each XmSimpleSpinBox callback: + + +typedef struct { + int reason; + XEvent *event; + Widget widget; + Boolean doit; + int position; + XmString value; + Boolean crossed_boundary; +} XmSimpleSpinBoxCallbackStruct; + +The reason argument indicates why the +callback was invoked. There are three possible reasons for this callback to +be issued. The reason is XmCR_OK +when this is the first call to the callback at the beginning of a spin or +if it is a single activation of the spin arrows. If the XmSimpleSpinBox is in the +process of being continuously spun, then the reason will be XmCR_SPIN_NEXT or XmCR_SPIN_PRIOR, depending on the arrow that is spinning. +The event argument points to the XEvent that triggered the callback. It can be NULL when the XmSimpleSpinBox is continuously spinning. + +The widget argument is the widget identifier +for the simple spin box widget that has been affected by this callback. +The doit argument is set only when +the call_data comes from the XmNmodifyVerifyCallback. It indicates that the +action that caused the callback to be called should be performed. The action +is not performed if doit is set to False. + +The position argument is the new value +of the XmNposition resource as a +result of the spin. +The value argument is the new XmString value displayed in the Text widget as +a result of the spin. The application must copy this string if it is used +beyond the scope of the call_data structure. + +The crossed_boundary argument is True +when the spinbox cycles. This is the case when a XmNspinBoxChildType of XmSTRING wraps from the first item to the last or the last item to the +first. In the case of the XmNspinBoxChildType of XmNUMERIC, the +boundary is crossed when the XmSimpleSpinBox cycles from the maximum value to the +minimum or vice versa. + + + +ERRORS/WARNINGS +The toolkit will display a warning if the application tries to +set the value of the XmNtextField resource, which is read-only +(marked G in the resource table). + + + +SEE ALSO +&cdeman.XmSpinBox;, +&cdeman.XmCreateSpinBox;, &cdeman.XmSimpleSpinBoxAddItem;, &cdeman.XmSimpleSpinBoxDeletePos;, XtGetValues(3), XtSetValues(3) ]]>Composite, Core, XmManager, XmText, XmTextField, in the &str-ZM;; XtGetValues, XtSetValues in the &str-Zt;. ]]> + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBoxA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBoxA.sgm new file mode 100644 index 00000000..e5619d2c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SSpinBoxA.sgm @@ -0,0 +1,63 @@ + + + + + + + + + + +XmSimpleSpinBoxAddItem +library call + + +XmSimpleSpinBoxAddItem +add an item to the XmSimpleSpinBox + + + + +#include <Xm/SSpinB.h> + +void XmSimpleSpinBoxAddItem +Widget w +XmString item +int pos + + + +DESCRIPTION +The +XmSimpleSpinBoxAddItem function adds the given item to the XmSimpleSpinBox at the given +position. + +The +w argument specifies the widget ID. + +The +item argument specifies the +XmString for the new item. + +The +pos argument specifies the position of the new item. + + + +RETURN VALUE +The +XmSimpleSpinBoxAddItem function returns no value. + + + +SEE ALSO +&cdeman.XmSimpleSpinBox;, +]]> +XmSimpleSpinBox, +]]> +&cdeman.XmSimpleSpinBoxDeletePos;, &cdeman.XmSimpleSpinBoxSetItem;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Scale.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Scale.sgm new file mode 100644 index 00000000..acc8c772 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Scale.sgm @@ -0,0 +1,1746 @@ + + + + + + + + + + + +XmScale +library call + + +XmScale +The Scale widget class + +XmScale + +widget class +Scale + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Scale.h> + + + +DESCRIPTION +Scale is used by an application to indicate a +value from within a range of values, and it allows the user to input or modify +a value from the same range. + +A Scale has an elongated rectangular region similar to a +ScrollBar. A slider inside this region +indicates the current value along the Scale. The user can also +modify the Scale's value by moving the slider within the +rectangular region of the Scale. A Scale can also include a label set +located outside the Scale region. +These can indicate the relative value at various positions +along the scale. +The placement of this label depends on the XmNlayoutDirection +resource of the widget. + +A Scale can be either input/output or output only. An input/output +Scale's value can be set by the application and also +modified by the user with the slider. An output-only Scale +is used strictly as an indicator of the current value of something +and cannot be modified interactively by the user. +The XmScale resource XmNeditable specifies whether the user can +interactively modify the Scale's value. + +The user can specify resources in a resource file for the automatically +created gadget that contains the title of the Scale widget. The name of the +gadget is Title. +The placement of the title depends on the +XmNlayoutDirection +resource of the widget. The direction of the title is based on +the widget's layout direction. + +Scale uses the XmQTspecifyRenderTable trait, and +holds the XmQTtransfer trait. + + +Data Transfer Behavior +Scale supports dragging of the representation of the Scale value from +the Scale when the value is displayed +and when the value of the XmNenableUnselectableDrag resource +of XmDisplay is set to True. + +As a source of data, Scale supports the following targets and associated +conversions of data to these targets: + + + +COMPOUND_TEXT + +The widget transfers a string representation of XmNvalue as type +COMPOUND_TEXT. + + + + +STRING + +The widget transfers a string representation of XmNvalue as type +STRING. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for the CLIPBOARD selection. +These include STRING and COMPOUND_TEXT. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +These include STRING and COMPOUND_TEXT. + + + + +As a source of data, Scale also supports the following standard Motif +targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +These also include STRING and COMPOUND_TEXT. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + + + +Descendants +Scale automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +Scrollbar +XmScrollBar +scroll bar + + +Title +XmLabelGadget +title of scale + + + + + + +Classes +Scale inherits behavior, resources, and traits from +Core, Composite, Constraint, and XmManager +classes. + +The class pointer is xmScaleWidgetClass. + +The class name is XmScale. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmScale Resource Set + + +Name +Class +Type +Default +Access + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdecimalPoints +XmCDecimalPoints +short +0 +CSG + + +XmNdragCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNeditable +XmCEditable +Boolean +True +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNmaximum +XmCMaximum +int +100 +CSG + + +XmNminimum +XmCMinimum +int +0 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmVERTICAL +CSG + + +XmNprocessingDirection +XmCProcessingDirection +unsigned char +dynamic +CSG + + +XmNscaleHeight +XmCScaleHeight +Dimension +0 +CSG + + +XmNscaleMultiple +XmCScaleMultiple +int +dynamic +CSG + + +XmNscaleWidth +XmCScaleWidth +Dimension +0 +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNshowArrows +XmCShowArrows +XtEnum +XmNONE +CSG + + +XmNshowValue +XmCShowValue +XtEnum +XmNONE +CSG + + +XmNsliderMark +XmCSliderMark +XtEnum +dynamic +CSG + + +XmNsliderVisual +XmCSliderVisual +XtEnum +dynamic +CSG + + +XmNslidingMode +XmCSlidingMode +XtEnum +XmSLIDER +CSG + + +XmNtitleString +XmCTitleString +XmString +NULL +CSG + + +XmNvalue +XmCValue +int +dynamic +CSG + + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +XmNconvertCallback + +Specifies a list of callbacks called when the Scale is asked to convert +a selection. +The type of the structure whose address is passed to these callbacks is +XmConvertCallbackStruct. +The reason is XmCR_OK. + + + + +XmNdecimalPoints + +Specifies the number of decimal points to shift the slider value when +displaying it. For example, a slider value of 2,350 +and an XmdecimalPoints +value of 2 results in a display value of 23.50. +The value must not be negative. + + + + +XmNdragCallback + +Specifies the list of callbacks that is called +when the slider position changes as the slider is being +dragged. The reason sent by the callback is XmCR_DRAG. + + + + +XmNeditable + +Specifies how the Scale scrollbar will react to user input. This +resource can be True or False values, as follows: + + + +True + +Allows the scrollbar to be sensitive to user input. This is the +default value. + + + + +False + +Makes the Scale scrollbar insensitive to user input. The visual is not +greyed out. This value would mostly be used in XmTHERMOMETER +mode. + + + + + +When XmNeditable is used on a widget +it sets the dropsite to XmDROP_SITE_ACTIVE. + + + + +XmNfontList + +Specifies the font list to use for the title text string specified by +XmNtitleString, and the label displayed when XmNshowValue +is True. The font list is an obsolete structure, and is retained only +for compatibility with earlier releases of Motif. See the +XmNrenderTable resource. + + + + +XmNhighlightOnEnter + +Specifies whether the highlighting rectangle is drawn when the cursor moves +into the widget. +If the shell's focus policy is XmEXPLICIT, this resource is +ignored, and the widget is highlighted when it has the focus. +If the shell's focus policy +is XmPOINTER and if this resource is +True, the highlighting rectangle is drawn when the the cursor moves into +the widget. +If the shell's focus +policy is XmPOINTER and if this resource is +False, the highlighting rectangle is not drawn when the the cursor moves +into the widget. +The default is False. + + + + +XmNhighlightThickness + +Specifies the size of the +slider's border drawing rectangle used for enter window and +traversal highlight drawing. + + + + +XmNmaximum + +Specifies the slider's maximum value. +XmNmaximum must be greater than XmNminimum. + + + + +XmNminimum + +Specifies the slider's minimum value. +XmNmaximum must be greater than XmNminimum. + + + + +XmNorientation + +Displays Scale vertically or horizontally. +This resource can have values of XmVERTICAL and XmHORIZONTAL. + + + + +XmNprocessingDirection + +Specifies whether the value for XmNmaximum is on the right or +left side of XmNminimum for horizontal Scales +or above or below XmNminimum for vertical Scales. +This resource can have values of XmMAX_ON_TOP, XmMAX_ON_BOTTOM, +XmMAX_ON_LEFT, and XmMAX_ON_RIGHT. +If the Scale is oriented vertically, the default value is +XmMAX_ON_TOP. +If the XmScale is oriented horizontally, the default value +depends on the XmNlayoutDirection resource of the widget. + + + + +XmNrenderTable + +Specifies the render table to use for the title text string specified +by XmNtitleString, and the label displayed when +XmNshowValue is True. If this value is NULL at initialization, +the parent hierarchy is searched for an ancestor that holds the +XmQTspecifyRenderTable trait. If such an ancestor is found, the +render table is initialized to the XmLABEL_RENDER_TABLE value of +the ancestor widget. If no such ancestor is found, the default is +implementation dependent. If a font list (XmNfontList) and a +render table are both specified, the render table will take +precedence. Refer to &cdeman.XmRenderTable; for more information on +the creation and structure of a render table. + + + + +XmNscaleHeight + +Specifies the height of the slider area. +The value should be in the specified unit type (the default is pixels). +If no value is specified a default height is computed. + + + + +XmNscaleMultiple + +Specifies the amount to move the slider when the user takes an action +that moves the slider by a multiple increment. +The default is (XmNmaximum − XmNminimum) divided by 10, +with a minimum of 1. + + + + +XmNscaleWidth + +Specifies the width of the slider area. +The value should be in the specified unit type (the default is pixels). +If no value is specified a default width is computed. + + + + +XmNshowArrows + +Specifies whether the arrows are displayed +and how they are to be displayed. This resource can take the +following values: + + + +XmEACH_SIDE + +Indicates that one arrow is displayed on each end of the ScrollBar slider. + + + + +XmMAX_SIDE + +Indicates that one arrow is displayed on the XmNmaximum side of +the ScrollBar slider. + + + + +XmMIN_SIDE + +Indicates that one arrow is displayed on the XmNminimum side of +the ScrollBar slider. + + + + +XmNONE + +Indicates that no arrows are displayed. + + + + +XmNONE is the default value. + + + + +XmNshowValue + +Specifies whether a label for the current slider +value should be displayed next to the slider. If the value is +XmNEAR_SLIDER, the current slider value is displayed. If the +value is XmNONE, no slider value is displayed. +If the value is XmNEAR_BORDER, the current slider value is +displayed near the border. + + + + +XmNsliderMark + +Specifies the shape the slider is to be displayed in. This resource +can take the following values: + + + +XmETCHED_LINE + +Specifies the slider as an etched line. This is the default when +XmNslidingMode is XmSLIDER. + + + + +XmNONE + +Specifies the slider as a foregrounded rectangle. This is the default when +XmNslidingMode is XmTHERMOMETER and the Scale scrollbar is +insensitive to user input (XmNeditable is False. + + + + +XmROUND_MARK + +Specifies the slider as a shadowed circle. This is the default when +XmNslidingMode is XmTHERMOMETER and the Scale scrollbar is +sensitive to user input (XmNeditable is True. + + + + +XmTHUMB_MARK + +Specifies the slider as a series of three etched lines centered in the +middle of the slider. + + + + + + + +XmNslidingMode + +Specifies the mode the slider works in. There are two possible modes: + + + +XmSLIDER + +Allows the slider to move freely between the minimum and maximum ends +of the scale. This is the default value. + + + + +XmTHERMOMETER + +Forces the slider to be anchored to one side of the trough area. + + + + + + + +XmNsliderVisual + +Specifies the color of the slider visual. +This resource can take +the following values: + + + +XmBACKGROUND_COLOR + +Specifies that the slider visual is in the background color. + + + + +XmFOREGROUND_COLOR + +Specifies that the slider visual is in the foreground color. + + + + +XmSHADOWED_BACKGROUND + +Specifies that the slider visual is in the background color, with a shadow. +This is the +default when the XmNslidingModel resource is XmSLIDER. + + + + +XmTROUGH_COLOR + +Specifies that the slider visual is in the trough color. This is the +default when the XmNslidingModel resource is XmTHERMOMETER. + + + + + + + +XmNtitleString + +Specifies the title text string to appear in the Scale widget window. + + + + +XmNvalue + +Specifies the slider's current position along the scale, +between XmNminimum and XmNmaximum. +The value is constrained to be within these inclusive bounds. +The initial value of this resource is the larger of 0 (zero) +and XmNminimum. + + + + +XmNvalueChangedCallback + +Specifies the list of callbacks that is called +when the value of the slider has changed. The reason +sent by the callback is XmCR_VALUE_CHANGED. + + + + + + +Inherited Resources +Scale inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to the +XmNdragCallback and XmNvalueChangedCallback procedures: + +typedef struct +{ + int reason; + XEvent * event; + int value; +} XmScaleCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +value + +Is the new slider value + + + + +A pointer to the following structure is passed to the +XmNconvertCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + Atom target; + XtPointer source_data; + XtPointer location_data; + int flags; + XtPointer parm; + int parm_format; + unsigned long parm_length; + int status; + XtPointer value; + Atom type; + int format; + unsigned long length; +} XmConvertCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which conversion is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, +and _MOTIF_DROP. + + + + +target + +Indicates the conversion target. + + + + +source_data + +Contains information about the selection source. +When the selection is _MOTIF_DROP, source_data is the +DragContext. +Otherwise, it is NULL. + + + + +location_data + +Contains information about the location of data to be converted. +If the value is NULL, the data to be transferred consists of the +widget's current selection. + + + + +flags + +Indicates the status of the conversion. Following are the possible +values: + + + +XmCONVERTING_NONE + +This flag is currently unused. + + + + +XmCONVERTING_PARTIAL + +The target widget was able to be converted, but some data was lost. + + + + +XmCONVERTING_SAME + +The conversion target is the source of the data to be transferred. + + + + +XmCONVERTING_TRANSACT + +This flag is currently unused. + + + + + + + +parm + +Contains parameter data for this target. +If no parameter data exists, the value is NULL. + +When selection is CLIPBOARD and target is +_MOTIF_CLIPBOARD_TARGETS or +_MOTIF_DEFERRED_CLIPBOARD_TARGETS, the value is the requested +operation (XmCOPY, XmMOVE, or XmLINK). + + + + +parm_format + +Specifies whether the data in parm should be viewed +as a list of char, short, or long quantities. +Possible values are 0 (when parm is NULL), +8 (when the data in parm should be viewed as a list of chars), +16 (when the data in parm should be viewed as a list of shorts), +or 32 (when the data in parm should be viewed as a list of longs). +Note that parm_format symbolizes a data type, not the number of bits +in each list element. +For example, on some machines, a parm_format of 32 means that +the data in parm should be viewed as a list of 64-bit quantities, +not 32-bit quantities. + + + + +parm_length + +Specifies the number of elements of data in parm, where each +element has the size specified by parm_format. +When parm is NULL, the value is 0. + + + + +status + +An IN/OUT member that specifies the status of the conversion. +The initial value is XmCONVERT_DEFAULT. +The callback procedure can set this member to one of the following +values: + + + +XmCONVERT_DEFAULT + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it +overwrites the data provided by the callback procedures in the value +member. + + + + +XmCONVERT_MERGE + +This value means that the widget class conversion procedure, if any, is +called after the callback procedures return. +If the widget class conversion procedure produces any data, it appends +its data to the data provided by the callback procedures in the +value member. +This value is intended for use with targets that result in lists of +data, such as TARGETS. + + + + +XmCONVERT_DONE + +This value means that the callback procedure has successfully finished +the conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + +XmCONVERT_REFUSE + +This value means that the callback procedure has terminated the +conversion process without completing the requested conversion. +The widget class conversion procedure, if any, is not called after the +callback procedures return. + + + + + + + +value + +An IN/OUT parameter that contains any data that the callback procedure +produces as a result of the conversion. +The initial value is NULL. +If the callback procedure sets this member, it must ensure that the +type, format, and length members correspond +to the data in value. +The callback procedure is responsible for allocating, but not for +freeing, memory when it sets this member. + + + + +type + +An IN/OUT parameter that indicates the type of the data in the +value member. +The initial value is INTEGER. + + + + +format + +An IN/OUT parameter that specifies whether the data in value should +be viewed as a list of char, short, or long quantities. +The initial value is 8. +The callback procedure can set this member to 8 (for a list of char), +16 (for a list of short), or 32 (for a list of long). + + + + +length + +An IN/OUT member that specifies the number of elements of data in +value, where each element has the size symbolized by format. +The initial value is 0. + + + + + + + + + + + + + + + + +Behavior +XmScale has the following behavior: + + + +Btn1Down or Btn2Down: + +In the region between an end of the Scale and the slider: +Moves the slider by one multiple increment in +the direction of the end of the +Scale and calls the XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, movement toward +the right or +bottom increments the Scale value, +and movement toward the left or top decrements the Scale value. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom decrements the Scale value, +and movement toward the left or top increments the Scale value. +If the button is held down longer than a delay period, the slider is +moved again by the same increment and the same callbacks are called. + +In slider: +Activates the interactive dragging of the slider. + + + + +Btn2Down in value label: + +Drags the contents of the label showing the current slider value. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. + + + + +Btn1Motion or Btn2Motion: + +If the button press occurs within the slider, the subsequent motion +events move the slider to the position of the pointer and call the +callbacks for XmNdragCallback. + + + + +Btn1Up or Btn2Up: + +If the button press occurs within the slider and the slider position +is changed, the callbacks for XmNvalueChangedCallback are called. + + + + +CtrlBtn1Down: + +In the region between an end of the Scale and the slider: +Moves the slider to that end of the Scale and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, +movement toward the right or bottom increments the Scale value, +and movement toward +the left or top +decrements +the Scale value. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom decrements the Scale value, +and movement toward the left or top increments the Scale value. + + + + +KeyosfUp: + +For vertical Scales, +moves the slider up one increment and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_TOP, movement toward +the top increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward +the top decrements the Scale value. + + + + +KeyosfDown: + +For vertical Scales, +moves the slider down one increment and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward +the bottom increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_TOP, movement toward +the bottom decrements the Scale value. + + + + +KeyosfLeft: + +For horizontal Scales, +moves the slider one increment to the left and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_LEFT, movement toward +the left increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward +the left decrements the Scale value. + + + + +KeyosfRight: + +For horizontal Scales, +moves the slider one increment to the right and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward +the right increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_LEFT, movement toward +the right decrements the Scale value. + + + + +CtrlKeyosfUp or KeyosfPageUp: + +For vertical Scales, +moves the slider up one multiple increment and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_TOP, movement toward +the top increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward +the top decrements the Scale value. + + + + +CtrlKeyosfDown or KeyosfPageDown: + +For vertical Scales, +moves the slider down one multiple increment and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward +the bottom increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_TOP, movement toward +the bottom decrements the Scale value. + + + + +CtrlKeyosfLeft or KeyosfPageLeft: + +For horizontal Scales, +moves the slider one multiple increment to the left and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_LEFT, movement toward +the left increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward +the left decrements the Scale value. + + + + +CtrlKeyosfRight or KeyosfPageRight: + +For horizontal Scales, +moves the slider one multiple increment to the right and calls the +XmNvalueChangedCallback callbacks. +If XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward +the right increments the Scale value. +If XmNprocessingDirection is XmMAX_ON_LEFT, movement toward +the right decrements the Scale value. + + + + +KeyosfBeginLine or KeyosfBeginData: + +Moves the slider to the minimum value and calls the +XmNvalueChangedCallback callbacks. + + + + +KeyosfEndLine or KeyosfEndData: + +Moves the slider to the maximum value and calls the +XmNvalueChangedCallback callbacks. + + + + +KeyosfNextField: + +Traverses to the first item in the next tab group. If +the current tab group is the last entry in the tab group list, it +wraps to the beginning of the tab group list. + + + + +KeyosfPrevField: + +Traverses to the first item in the previous tab group. +If the beginning of the tab group list is reached, it wraps to the end +of the tab group list. + + + + +KeyosfHelp: + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, +&cdeman.XmCreateScale;, +&cdeman.XmManager;, +&cdeman.XmScaleGetValue;, and +&cdeman.XmScaleSetValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleGV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleGV.sgm new file mode 100644 index 00000000..17586555 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleGV.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmScaleGetValue +library call + + +XmScaleGetValue +A Scale function that returns the current slider position + +XmScaleGetValue + +Scale functions +XmScaleGetValue + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Scale.h> + +void XmScaleGetValue + +Widget widget +int * value_return + + + +DESCRIPTION +XmScaleGetValue returns the current slider position value +displayed in the scale. + + + +widget + +Specifies the Scale widget ID + + + + +value_return + +Returns the current slider position value + + + + +For a complete definition of Scale and its associated resources, see +&cdeman.XmScale;. + + + +RELATED +&cdeman.XmScale;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScalePix.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScalePix.sgm new file mode 100644 index 00000000..c699a55b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScalePix.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + +XmGetScaledPixmap +library call + + +XmGetScaledPixmap + +read a pixmap file and scale it according to pixmap and print resolution + + + + +#include <Xm/Xm.h> + +XtEnum XmGetScaledPixmap +Widget widget +String image_name +Pixel foreground +Pixel background +int depth +Double scaling_ratio + + + +DESCRIPTION +XmGetScaledPixmap uses its +Widget +argument to look up +for a Print Shell ancestor to get the pixmap resolution +and the default printer resolution information to be used +if +scaling_ratio +==0. + +If scaling is 0, and a valid PrintShell is present +XmGetScaledPixmap +applies a ratio equals to +(printer resolution / default pixmap resolution) +before creating the Pixmap on the widget's Screen. +Otherwise, the +scaling_ratio +is used in scaling +both dimensions of the image being converted as a Pixmap. + +XmGetScaledPixmap completes the +XmGetPixmapByDepth existing +API by making use of the +XmNdefaultPixmapResolution +of the rooting +XmPrintShell. +Refer to the +XmGetPixmapByDepth documentation for details. + + +widget + +Widget used to determine the default pixmap resolution (of the print shell ancestor). + + + +image_name + +See XmGetPixmapByDepth for description. + + + +foreground + +See XmGetPixmapByDepth for description. + + + +background + +See XmGetPixmapByDepth for description. + + + +depth + +See XmGetPixmapByDepth for description. + + + +scaling_ratio + +Indicate the scaling ratio to be applied, or 0. + + + + + + +RETURN VALUE +Returns Pixmap or NULL if failed. + + + +ERRORS/WARNINGS +Same as for XmGetPixmapByDepth. + + + +SEE ALSO +&cdeman.XmPrintSetup;, &cdeman.XmPrintShell;, &cdeman.XmRedisplayWidget; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleST.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleST.sgm new file mode 100644 index 00000000..07e79b82 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleST.sgm @@ -0,0 +1,132 @@ + + + + + + + + + + + +XmScaleSetTicks +library call + + +XmScaleSetTicks +A Scale function that controls tick marks + +XmScaleSetTicks + +Scale functions +XmScaleSetTicks + + + + + + + + + + + +#include <Xm/Scale.h> + +void XmScaleSetTicks + +Widget scale +int big_every +Cardinal num_medium +Cardinal num_small +Dimension size_big +Dimension size_medium +Dimension size_small + + + +DESCRIPTION +XmScaleSetTicks controls the number, location, and size of the +tick marks on a Scale. Each tick mark is a SeparatorGadget oriented +perpendicular to the Scale's orientation. For example, if the Scale +is oriented horizontally, the tick marks will be oriented vertically. + +If you specify tick marks for a Scale and then change the +Scale's orientation, you will have to do the following: + + + +Remove all the tick marks. To remove tick marks from a Scale, +you must destroy (with XtDestroyChildren) +the SeparatorGadget tick marks. +The first two children of a Scale are its title and scroll bar, and +all additional children are tick marks. + + + +Recreate the tick marks by calling XmScaleSetTicks. + + + + + +scale + +Specifies the Scale widget ID that is getting the tick marks. + + + + +big_every + +Specifies the number of scale values between big ticks. + + + + +num_medium + +Specifies the number of medium ticks between big values. + + + + +num_small + +Specifies the number of small ticks between medium values. + + + + +size_big + +Specifies the size (either width or height) of the big ticks. + + + + +size_medium + +Specifies the size (either width or height) of the medium ticks. + + + + +size_small + +Specifies the size (either width or height) of the small ticks. + + + + +For a complete definition of Scale and its associated resources, see +&cdeman.XmScale;. + + + +RELATED +&cdeman.XmScale;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleSV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleSV.sgm new file mode 100644 index 00000000..1901e199 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScaleSV.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmScaleSetValue +library call + + +XmScaleSetValue +A Scale function that sets a slider value + +XmScaleSetValue + +Scale functions +XmScaleSetValue + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Scale.h> + +void XmScaleSetValue + +Widget widget +int value + + + +DESCRIPTION +XmScaleSetValue sets the slider value within the +Scale widget. + + + +widget + +Specifies the Scale widget ID. + + + + +value + +Specifies the slider position along the scale. +This sets the XmNvalue resource. + + + + +For a complete definition of Scale and its associated resources, see +&cdeman.XmScale;. + + + +RELATED +&cdeman.XmScale;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Screen.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Screen.sgm new file mode 100644 index 00000000..189c1987 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Screen.sgm @@ -0,0 +1,911 @@ + + + + + + + + + + + +XmScreen +library call + + +XmScreen +The Screen widget class + +XmScreen + +widget class +XmScreen + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Screen.h> + + + +DESCRIPTION +The XmScreen object is used by Motif widgets to store information that +is specific to a screen. It also allows the toolkit to store certain +information on widget hierarchies that would otherwise be unavailable. +Each client has one XmScreen object for each screen that it accesses. + +An XmScreen object is automatically created when the application creates +the first shell on a screen (usually accomplished by a call to +XtAppInitialize or XtAppCreateShell). +It is not necessary to create an XmScreen object by any other means. +An application can use the function XmGetXmScreen to obtain the +widget ID of the XmScreen object for a given screen. + +An application cannot supply initial values for XmScreen resources as +arguments to a call to any function that creates widgets. +The application or user can supply initial values in a resource file. +After creating the first shell on the screen, the application can use +XmGetXmScreen to obtain the widget ID of the XmScreen object and +then call XtSetValues to set the XmScreen resources. + + +Classes +Screen inherits behavior and resources from Core. + +The class pointer is xmScreenClass. + +The class name is XmScreen. + + + +New Resources +The following table defines a set of widget resources used by the +programmer to specify data. The programmer can also set the resource +values for the inherited classes to set attributes for this widget. +To reference a resource by name or by class in an &npzwc;.Xdefaults file, +remove the XmN or XmC prefix and use the remaining letters. +To specify one of the defined values for a resource in an &npzwc;.Xdefaults +file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between +words). The codes in the access column indicate if the given resource +can be set at creation time (C), set by using XtSetValues +(S), retrieved by using XtGetValues (G), or is not +applicable (N/A). + + + + + + + + + + + +XmScreen Resource Set + + +Name +Class +Type +Default +Access + + +XmNbitmapConversionModel +XmCBitmapConversionModel +XtEnum +XmPIXMAP +CSG?? + + +XmNcolorAllocationProc +XmCColorAllocationProc +XtProc +NULL +CSG?? + + +XmNcolorCalculationProc +XmCColorCalculationProc +XtProc +NULL +CSG?? + + +XmNdarkThreshold +XmCDarkThreshold +int +dynamic +C + + +XmNdefaultCopyCursorIcon +XmCDefaultCopyCursorIcon +Widget +NULL +CSG + + +XmNdefaultInvalidCursorIcon +XmCDefaultInvalidCursorIcon +Widget +NULL +CSG + + +XmNdefaultLinkCursorIcon +XmCDefaultLinkCursorIcon +Widget +NULL +CSG + + +XmNdefaultMoveCursorIcon +XmCDefaultMoveCursorIcon +Widget +NULL +CSG + + +XmNdefaultNoneCursorIcon +XmCDefaultNoneCursorIcon +Widget +NULL +CSG + + +XmNdefaultSourceCursorIcon +XmCDefaultSourceCursorIcon +Widget +NULL +CSG + + +XmNdefaultValidCursorIcon +XmCDefaultValidCursorIcon +Widget +NULL +CSG + + +XmNfont +XmCFont +XFontStruct * +NULL +CSG + + +XmNforegroundThreshold +XmCForegroundThreshold +int +dynamic +C + + +XmNhorizontalFontUnit +XmCHorizontalFontUnit +int +dynamic +CSG + + +XmNinsensitiveStippleBitmap +XmCinsensitiveStippleBitmap +Bitmap +"50_foreground" +CSG + + +XmNlightThreshold +XmCLightThreshold +int +dynamic +C + + +XmNmenuCursor +XmCCursor +Cursor +arrow +C + + +XmNmoveOpaque +XmCMoveOpaque +Boolean +False +CSG + + +XmNunpostBehavior +XmCUnpostBehavior +unsigned char +XmUNPOST_AND_REPLAY +CSG + + +XmNuseColorObject +XmCUseColorObject +Boolean +False +C + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + +XmNverticalFontUnit +XmCVerticalFontUnit +int +dynamic +CSG + + + + + + +XmNbitmapConversionModel + +Provides a policy for the conversion of xbm and xpm files to the Pixmap +type. This resource takes the following values: + + + +XmMATCH_DEPTH + +From a supplied xbm or xpm file, generates a converted pixmap file having the +same depth as the widget. + + + + +XmDYNAMIC_DEPTH + +Converts an input xbm file to a Pixmap of depth 1, +or converts an input xpm file to a Pixmap having the +same depth as the widget. + + + + + + + +XmNcolorAllocationProc + +Identifies the procedure to be used for color allocation. +Normally, this procedure is an application-defined color allocation +procedure. However, if no application-defined color allocation +procedure is set, the system uses Motif's predefined color allocation +procedure. + + + + +XmNcolorCalculationProc + +Identifies the procedure to be used for per-widget color calculation. +Normally, this procedure is an application-defined color calculation +procedure. However, if no application-defined color calculation +procedure is set, the system uses Motif's predefined color calculation +procedure. + + + + +XmNdarkThreshold + +An integer between 0 (zero) and 100, inclusive, that specifies a level +of perceived brightness for a color. If the perceived brightness +of the background color is below this level, Motif treats the background +as "dark" when computing default shadow and select colors. +If this resource is specified for a particular screen, it applies to +widgets created on that screen; otherwise it applies to widgets +created on all screens. The default value is implementation +specific. + + + + +XmNdefaultCopyCursorIcon + +Specifies the DragIcon used during a drag operation when +the operation is a copy and no other pixmap is specified by +the application. If this resource is NULL, a system default icon is used. +The system default icon is +determined by the Display resource XmNenableDragIcon. + + + + +XmNdefaultInvalidCursorIcon + +Specifies the DragIcon used to indicate that the cursor +is over an invalid drop site during a drag operation when no +other pixmap symbol is specified by the application. If this resource is NULL, a +system default icon is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNdefaultLinkCursorIcon + +Specifies the DragIcon used during a drag operation when +the operation is a link and no other pixmap is specified +by the application. If this resource is NULL, a system default icon is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNdefaultMoveCursorIcon + +Specifies the DragIcon used during a drag operation when +the operation is a move and no other pixmap is specified by +the application. If this resource is NULL, a system default icon is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNdefaultNoneCursorIcon + +Specifies the DragIcon used to indicate that the cursor is +not over a drop site during a drag operation when no other pixmap +is specified by the application. If this resource is NULL, a system default icon +is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNdefaultSourceCursorIcon + +Specifies the depth-1 pixmap used as a cursor when an +XmNsourceCursorIcon is not provided by the DragContext, or +it is not usable. If this resource is NULL, a system default icon is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNdefaultValidCursorIcon + +Specifies the DragIcon used to indicate that the cursor is +over a valid drop site during a drag operation when no other pixmap +is specified by the application. If this resource is NULL, a system default icon +is used. +The system default icon is determined by the Display resource +XmNenableDragIcon. + + + + +XmNfont + +Specifies a font for use in computing values for +XmNhorizontalFontUnit and XmNverticalFontUnit. When an +application is initialized, this resource can be supplied in a +resource file or through the standard command line options −fn, +−font, and −xrm. Note that this resource is used only +for the calculation of the font unit values. To specify a font to be +used to display text, use a widget's render table resource +(XmNrenderTable). + + + + +XmNforegroundThreshold + +An integer between 0 (zero) and 100, inclusive, that specifies a level of +perceived brightness for a color. If the perceived brightness of the +background color is equal to or below this level, Motif treats the +background as "dark" when computing the default foreground and highlight +colors. If the perceived brightness of the background color is above +this level, Motif treats the background as "light" when computing the +default foreground and highlight colors. When the background is "dark," +the default foreground and highlight is white; when the background is +"light," the default foreground and highlight is black. If this +resource is specified for a particular screen, it applies to widgets +created on that screen; otherwise, it applies to widgets created on all +screens. The default value is implementation specific. + + + + +XmNhorizontalFontUnit + +Specifies the horizontal component of the font units used by +XmConvertUnits, and is used to interpret the values of geometry +resources when the XmNshellUnitType resource of VendorShell or the +XmNunitType resource of Gadget, Manager, or Primitive has the +value Xm100TH_FONT_UNITS. +If no initial value is supplied for this resource, the default is +computed from the font specified in XmNfont. +If no initial value is supplied for this resource or for XmNfont, +the default is 10. + +If a call to XtSetValues specifies a value for +XmNhorizontalFontUnit, this resource is set to that value. +If a call to XtSetValues specifies a value for XmNfont but +not for XmNhorizontalFontUnit, this resource is set to a value +computed from the new XmNfont. + +A horizontal font unit is derived from a font as follows: + + + +If the font has an AVERAGE_WIDTH property, the horizontal font +unit is the AVERAGE_WIDTH property divided by 10. + + + +If the font has no AVERAGE_WIDTH property but has a +QUAD_WIDTH property, the horizontal font unit is the +QUAD_WIDTH property. + + + +If the font has no AVERAGE_WIDTH or QUAD_WIDTH property, the +horizontal font unit is the sum of the font structure's min_bounds.width +and max_bounds.width divided by 2.3. + + + + + + +XmNinsensitiveStippleBitmap + +Provides widgets with the bitmap to use when generating the +insensitive visual. This bitmap is to be used as the stipple for the +rendering of insensitive visuals. + + + + +XmNlightThreshold + +An integer between 0 (zero) and 100, inclusive, that specifies a level of +perceived brightness for a color. If the perceived brightness of the +background color is above this level, Motif treats the background as +"light" when computing default shadow and select colors. If this +resource is specified for a particular screen, it applies to widgets +created on that screen; otherwise, it applies to widgets created on all +screens. The default value is implementation specific. + + + + +XmNmenuCursor + +Sets a variable that controls the cursor used whenever this +application posts a menu. This resource can be specified +only once at application +startup time, either by placing it within a defaults file or by using the +−xrm command line argument. For example: + + +myProg −xrm "*menuCursor: arrow" + + +The menu cursor can also be selected in the program through +the function XmSetMenuCursor. +The following list shows acceptable cursor names. If the application +does not specify a cursor or if an invalid name is supplied, the +default cursor (an arrow pointing up and to the right) is used. + + + +X_cursor + +leftbutton + + + + +arrow + +ll_angle + + + + +based_arrow_down + +lr_angle + + + + +based_arrow_up + +man + + + + +boat + +middlebutton + + + + +bogosity + +mouse + + + + +bottom_left_corner + +pencil + + + + +bottom_right_corner + +pirate + + + + +bottom_side + +plus + + + + +bottom_tee + +question_arrow + + + + +box_spiral + +right_ptr + + + + +center_ptr + +right_side + + + + +circle + +right_tee + + + + +clock + +rightbutton + + + + +coffee_mug + +rtl_logo + + + + +cross + +sailboat + + + + +cross_reverse + +sb_down_arrow + + + + +crosshair + +sb_h_double_arrow + + + + +diamond_cross + +sb_left_arrow + + + + +dot + +sb_right_arrow + + + + +dotbox + +sb_up_arrow + + + + +double_arrow + +sb_v_double_arrow + + + + +draft_large + +shuttle + + + + +draft_small + +sizing + + + + +draped_box + +spider + + + + +exchange + +spraycan + + + + +fleur + +star + + + + +gobbler + +target + + + + +gumby + +tcross + + + + +hand1 + +top_left_arrow + + + + +hand2 + +top_left_corner + + + + +heart + +top_right_corner + + + + +icon + +top_side + + + + +iron_cross + +left_ptr + + + + +left_side + +top_tee + + + + +left_tee + +trek + + + + +ul_angle + +umbrella + + + + +ur_angle + +watch + + + + +xterm + + + + + + + + +XmNmoveOpaque + +Specifies whether an interactive operation that moves a window, such as +tearing off and dragging a tear-off menu or moving a window in MWM, +displays an outline of the window or a representation of the window +itself during the move. +If the value is True, the operation displays a representation of the +window during the move. +If the value is False, the operation displays an outline of the window. + + + + +XmNunpostBehavior + +Specifies the behavior of an active menu posted in traversal mode when +a subsequent menu button selection is made outside the posted +menu. When the value is XmUNPOST_AND_REPLAY, the resource +unposts the menu hierarchy and causes the server to replay the event to the +window in which the pointer is located. When the value is +XmUNPOST, the resource unposts the hierarchy without replaying the +event. + + + + +XmNuseColorObject + +Enables and disables the sharing of colors between widgets, and the +dynamic changing of colors. A value of False disables this, and a +value of True enables it. + + + + +XmNuserData + +Allows the application to attach +any necessary specific data to the widget. This is an internally +unused resource. + + + + +XmNverticalFontUnit + +Specifies the vertical component of the font units used by +XmConvertUnits and used to interpret the values of geometry +resources when the XmNshellUnitType resource of VendorShell or the +XmNunitType resource of Gadget, Manager, or Primitive has the +value Xm100TH_FONT_UNITS. +If no initial value is supplied for this resource, the default is +computed from the font specified in XmNfont. +If no initial value is supplied for this resource or for XmNfont, +the default is 10. + +If a call to XtSetValues specifies a value for +XmNverticalFontUnit, this resource is set to that value. +If a call to XtSetValues specifies a value for XmNfont but +not for XmNverticalFontUnit, this resource is set to a value +computed from the new XmNfont. + +A vertical font unit is derived from a font as follows: + + + +If the font has a PIXEL_SIZE property, the vertical font unit is +the PIXEL_SIZE property divided by 1.8. + + + +If the font has no PIXEL_SIZE property but has POINT_SIZE +and RESOLUTION_Y properties, the vertical font unit is the product +of the POINT_SIZE and RESOLUTION_Y properties divided by +1400. + + + +If the font has no PIXEL_SIZE, POINT_SIZE, or +RESOLUTION_Y properties, the vertical font unit is the sum of the +font structure's max_bounds.ascent and +max_bounds.descent divided by 2.2. + + + + + + + + +Inherited Resources +All of the superclass resources inherited by XmScreen are +designated N/A (not applicable). + + + + +RELATED +&cdeman.Core;, +&cdeman.XmDisplay;, +&cdeman.XmGetXmScreen;, and +&cdeman.XmSetMenuCursor;, + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollA.sgm new file mode 100644 index 00000000..5ea74f19 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollA.sgm @@ -0,0 +1,1186 @@ + + + + + + + + + + + +XmScrolledWindow +library call + + +XmScrolledWindow +The ScrolledWindow widget class + +XmScrolledWindow + +widget class +ScrolledWindow + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/ScrolledW.h> + + + +DESCRIPTION +The ScrolledWindow widget combines one or two ScrollBar widgets and a +viewing area to implement a visible window onto some other (usually larger) +data display. The visible part of the window can be scrolled through the +larger display by the use of ScrollBars. + +To use ScrolledWindow, an application first creates a ScrolledWindow +widget, any needed ScrollBar widgets, and a widget capable of displaying +any desired data as the work area of ScrolledWindow. ScrolledWindow +positions the work area widget and displays the ScrollBars if so +requested. When the user performs some action on the ScrollBar, the +application is notified through the normal ScrollBar callback +interface. + +ScrolledWindow can be configured to operate automatically so +that it performs all scrolling and display actions with no need for application +program involvement. It can also be configured to provide a minimal support +framework in which the application is responsible for processing all user input +and making all visual changes to the displayed data in response to that input. + +When ScrolledWindow is performing automatic scrolling it creates a +clipping window and automatically creates the scroll bars. +Conceptually, this window becomes the viewport through which +the user examines the larger underlying data area. The application simply +creates the desired data, then makes that data the work area of the +ScrolledWindow. +When the user moves the slider to change the displayed data, the +workspace is moved under the viewing area so that a new portion of the data +becomes visible. + +Sometimes it is impractical for an application to create a +large data space and simply display it through a small clipping window. For +example, in a text editor, creating a single data area that consisted of a +large file would involve an undesirable amount of overhead. +The application needs to use a ScrolledWindow +(a small viewport onto some larger data), but needs to be notified +when the user scrolls the viewport so it can bring in more data from +storage and update the display area. For these cases, the ScrolledWindow can be +configured so that it provides only visual layout support. No clipping window +is created, and the application must maintain the data displayed in the +work area, as well as respond to user input on the ScrollBars. + +The user can specify resources in a resource file for the automatically +created widgets that contain the horizontal and vertical scrollbars +and the clipping area of +the ScrolledWindow widget. The names of these widgets are +HorScrollBar, VertScrollBar, and ClipWindow respectively, +and remain consistent whether created by +XmCreateScrolledList, XmCreateScrolledText or +XmCreateScrolledWindow. + +ScrolledWindow uses the XmQTnavigator trait, and +holds the XmQTscrollFrame trait. + + +Descendants +ScrolledWindow automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +VertScrollBar +XmScrollBar +vertical scroll bar + + +HorScrollBar +XmScrollBar +horizontal scroll bar + + +ClipWindow +XmClipWindow +clip window + + + + + + +Classes +ScrolledWindow inherits behavior, +resources, and traits from Core, Composite, +Constraint, and XmManager. + +The class pointer is xmScrolledWindowWidgetClass. + +The class name is XmScrolledWindow. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmScrolledWindow Resource Set + + +Name +Class +Type +Default +Access + + +XmNautoDragModel +XmCAutoDragModel +XtEnum +XmAUTO_DRAG_ENABLED +CSG + + +XmNclipWindow +XmCClipWindow +Widget +dynamic +G + + +XmNhorizontalScrollBar +XmCHorizontalScrollBar +Widget +dynamic +CSG + + +XmNscrollBarDisplayPolicy +XmCScrollBarDisplayPolicy +unsigned char +dynamic +CSG + + +XmNscrollBarPlacement +XmCScrollBarPlacement +unsigned char +XmBOTTOM_RIGHT +CSG + + +XmNscrolledWindowMarginHeight +XmCScrolledWindowMarginHeight +Dimension +0 +CSG + + +XmNscrolledWindowMarginWidth +XmCScrolledWindowMarginWidth +Dimension +0 +CSG + + +XmNscrollingPolicy +XmCScrollingPolicy +unsigned char +XmAPPLICATION_DEFINED +CG + + +XmNspacing +XmCSpacing +Dimension +4 +CSG + + +XmNtraverseObscuredCallback +XmCCallback +XtCallbackList +NULL +CSG + + +XmNverticalScrollBar +XmCVerticalScrollBar +Widget +dynamic +CSG + + +XmNvisualPolicy +XmCVisualPolicy +unsigned char +dynamic +G + + +XmNworkWindow +XmCWorkWindow +Widget +NULL +CSG + + + + + + +XmNautoDragModel + +Indicates whether automatic drag is enabled (XmAUTO_DRAG_ENABLED +or disabled (XmAUTO_DRAG_DISABLED). By default it is enabled. + + + + +XmNclipWindow + +Specifies the widget ID of the clipping area. This +is automatically created by +ScrolledWindow when the XmNvisualPolicy resource is set to +XmCONSTANT and +can only be read by the application. Any attempt to set this resource to a +new value causes a warning message to be printed by the scrolled +window. If the XmNvisualPolicy resource is set to XmVARIABLE, this +resource is set to NULL, and no clipping window is created. + + + + +XmNhorizontalScrollBar + +Specifies the widget ID of the horizontal ScrollBar. +This is automatically created by ScrolledWindow when the +XmNscrollingPolicy is initialized to XmAUTOMATIC; otherwise, +the default is NULL. + + + + +XmNscrollBarDisplayPolicy + +Controls the automatic placement of the ScrollBars. If +it is set to XmAS_NEEDED and if XmNscrollingPolicy is +set to XmAUTOMATIC, ScrollBars are displayed only if the +workspace exceeds the clip area in one or both dimensions. A resource value +of XmSTATIC causes the ScrolledWindow +to display the ScrollBars whenever +they are managed, regardless of the relationship between the clip window +and the work area. This resource must be XmSTATIC when +XmNscrollingPolicy is XmAPPLICATION_DEFINED. +The default is XmAS_NEEDED when XmNscrollingPolicy is +XmAUTOMATIC, and XmSTATIC otherwise. + + + + +XmNscrollBarPlacement + +Specifies the positioning of the ScrollBars +in relation to the work window. The +values are + + + +XmTOP_LEFT + +The horizontal ScrollBar is placed above the +work window; the vertical ScrollBar to +is placed the left. + + + + +XmBOTTOM_LEFT + +The horizontal ScrollBar is placed below the +work window; the vertical ScrollBar to +is placed the left. + + + + +XmTOP_RIGHT + +The horizontal ScrollBar is placed above the +work window; the vertical ScrollBar to +is placed the right. + + + + +XmBOTTOM_RIGHT + +The horizontal ScrollBar is placed below the +work window; the vertical ScrollBar to +is placed the right. + + + + +The default value +depends on the value of the +XmNlayoutDirection resource of the widget. + + + + +XmNscrolledWindowMarginHeight + +Specifies the margin height on the top and bottom of the +ScrolledWindow. +In order to use the autoscroll drag feature of the Motif drag and +drop facility, a user must be able to hold a drag icon over the margin +of a scrolled window. Though drag and drop will work with the default +margin size of zero, a user may find it difficult to position the icon +precisely enough to use the feature easily. The application programmer +should ensure that the window margins are set to an adequate size, if the +use of the autoscroll drag feature is desired. + + + + +XmNscrolledWindowMarginWidth + +Specifies the margin width on the right and left sides of the +ScrolledWindow. +Please refer to the warning concerning the default margin size for the +XmNscrolledWindowMarginHeight resource, above. + + + + +XmNscrollingPolicy + +Performs automatic scrolling of the +work area with no application interaction. If the value of this resource +is XmAUTOMATIC, ScrolledWindow automatically creates the +ScrollBars; attaches callbacks to the +ScrollBars; sets the visual policy to XmCONSTANT; +and automatically moves the +work area through the clip window in response to any user interaction with +the ScrollBars. An application can also add its own callbacks to the +ScrollBars. This allows the application to be notified of a scroll event +without having to perform any layout procedures. + +NOTE: Since the +ScrolledWindow adds callbacks to the ScrollBars, an application should not +perform an XtRemoveAllCallbacks on any of the ScrollBar widgets. + +When XmNscrollingPolicy is set to +XmAPPLICATION_DEFINED, the application +is responsible for all aspects of scrolling. The ScrollBars must be created +by the application, and it is responsible for performing any visual changes +in the work area in response to user input. + +This resource must be set to the desired policy at the time the +ScrolledWindow is created. It cannot be changed through SetValues. + + + + +XmNspacing + +Specifies the distance that separates the ScrollBars from the +work window. + + + + +XmNtraverseObscuredCallback + +Specifies a list of callbacks that is called when traversing to +a widget or gadget that is obscured due to its position in the +work area relative to the location of the ScrolledWindow viewport. +This resource is valid only when XmNscrollingPolicy is +XmAUTOMATIC. If this resource is NULL, an obscured widget +cannot be traversed to. The callback reason is +XmCR_OBSCURED_TRAVERSAL. + + + + +XmNverticalScrollBar + +Specifies the widget ID of the vertical ScrollBar. +This is automatically created by ScrolledWindow when the +XmNscrollingPolicy is initialized to XmAUTOMATIC; otherwise, +the default is NULL. + + + + +XmNvisualPolicy + +Enlarges the ScrolledWindow to match the size of the work area. It can +also be used as a static viewport onto +a larger data space. If the visual policy +is XmVARIABLE, the ScrolledWindow forces the ScrollBar display +policy to XmSTATIC and +allows the work area to grow or shrink +at any time and adjusts its layout to accommodate the new size. When +the policy is XmCONSTANT, the work area grows or shrinks +as requested, but a clipping window forces the size of the visible +portion to remain constant. The only time the viewing area can grow is +in response +to a resize from the ScrolledWindow's parent. +The default is XmCONSTANT when XmNscrollingPolicy is +XmAUTOMATIC, and XmVARIABLE otherwise. + +NOTE: This resource must be set to the desired policy at the time the +ScrolledWindow is created. It cannot be changed through SetValues. + + + + +XmNworkWindow + +Specifies the widget ID of the viewing area. + + + + + + + + + + + + + + + + + + + + + +XmScrolledWindow Constraint Resource Set + + +Name +Class +Type +Default +Access + + +XmNscrolledWindowChildType +XmCScrolledWindowChildType +unsigned char +RESOURCE_DEFAULT +CSG + + + + + + +XmNscrolledWindowChildType + +Specifies what the child is. ScrolledWindow supports a number of child +types. The possible values are: + + + +XmWORK_AREA + +Indicates a work area child. This specifies that both ScrollBars are +limited to moving the child inside the clipping window. If the +scrolling policy is +XmAUTOMATIC, the work area child can move in both directions. + + + + +XmHOR_SCROLLBAR + +Indicates a horizontal child widget; the child must have the +XmQTnavigator trait installed. +For example, the XmScrollBar widget has the +XmQTnavigator trait installed. + + + + +XmVERT_SCROLLBAR + +Indicates a vertical child widget; the child must have the +XmQTnavigator trait installed. + + + + +XmSCROLL_HOR + +Indicates that only the horizontal ScrollBar moves the child. This +value is only meaningful if the scrolling policy is XmAUTOMATIC. + + + + +XmSCROLL_VERT + +Indicates that only the vertical ScrollBar moves the child. This +value is only meaningful if the scrolling policy is XmAUTOMATIC. + + + + +XmNO_SCROLL + +Indicates that the child does not move with the ScrollBars. This +value is only meaningful if the scrolling policy is XmAUTOMATIC. + + + + + + + + + +Inherited Resources +ScrolledWindow inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +NULL +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +The application must use the ScrollBar callbacks to be notified of user +input. + +ScrolledWindow defines a callback structure +for use with XmNtraverseObscuredCallback callbacks. The +XmNtraverseObscuredCallback resource provides a mechanism +for traversal to obscured widgets (or gadgets) due to their +position in the work area of a ScrolledWindow. The +XmNtraverseObscuredCallback routine has responsibility +for adjusting the position of the work area such that the +specified traversal destination widget is positioned within +the viewport of the ScrolledWindow. A NULL XmNtraverseObscuredCallback +resource causes obscured widgets within the ScrolledWindow +to be nontraversable. + +Traversal to an obscured widget or gadget requires these +conditions to be met: the widget or gadget can be obscured +only due to its position in the work area of a ScrolledWindow +relative to the viewport; the viewport of the associated ScrolledWindow is +fully visible, or can be made so by virtue of ancestral +XmNtraverseObscuredCallback routines; and the +XmNtraverseObscuredCallback resource must be non-NULL. + +When ScrolledWindow widgets are nested, the +XmNtraverseObscuredCallback routine for each ScrolledWindow +that obscures the traversal destination is called in ascending order +within the given hierarchy. + +A pointer to the following structure is passed to callbacks +for XmNtraverseObscuredCallback. + +typedef struct +{ + int reason; + XEvent *event: + Widget traversal_destination; + XmTraversalDirection direction; +} XmTraverseObscuredCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +traversal_destination + +Specifies the widget or gadget to traverse to, which will +be a descendant of the work window. + + + + +direction + +Specifies the direction of traversal. See +the description of the direction parameter in +the XmProcessTraversal reference page for an explanation +of the valid values. + + + + + + + + + + + + + + + + +Translations +XmScrolledWindow includes the translations from XmManager. + + + +Additional Behavior +This widget has the following additional behavior: + + + +KeyosfPageUp: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window up the height of the viewport. +The distance scrolled may be reduced to provide some overlap. +The actual distance scrolled depends on the +XmNpageIncrement resource of the vertical ScrollBar. + + + + +KeyosfPageDown: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window down the height of the viewport. +The distance scrolled may be reduced to provide some overlap. +The actual distance scrolled depends on the +XmNpageIncrement resource of the vertical ScrollBar. + + + + +KeyosfPageLeft: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window left the width of the viewport. +The distance scrolled may be reduced to provide some overlap. +The actual distance scrolled depends on the +XmNpageIncrement resource of the horizontal ScrollBar. + + + + +KeyosfPageRight: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window right the width of the viewport. +The distance scrolled may be reduced to provide some overlap. +The actual distance scrolled depends on the +XmNpageIncrement resource of the horizontal ScrollBar. + + + + +KeyosfBeginLine: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window horizontally to the edge corresponding to the +horizontal ScrollBar's minimum value. + + + + +KeyosfEndLine: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window horizontally to the edge corresponding to the +horizontal ScrollBar's maximum value. + + + + +KeyosfBeginData: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window vertically to the edge corresponding to the +vertical ScrollBar's minimum value. + + + + +KeyosfEndData: + +If XmNscrollingPolicy is XmAUTOMATIC, +scrolls the window vertically to the edge corresponding to the +vertical ScrollBar's maximum value. + + + + +Certain applications will want to replace the page bindings with +ones that are specific to the content of the scrolled area. + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmCreateScrolledWindow;, +&cdeman.XmManager;, +&cdeman.XmProcessTraversal;, +&cdeman.XmScrollBar;, +&cdeman.XmScrollVisible;, and +&cdeman.XmScrolledWindowSetAreas;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollB.sgm new file mode 100644 index 00000000..4e6e7682 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollB.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmScrolledWindowSetAreas +library call + + +XmScrolledWindowSetAreas +A ScrolledWindow function that adds or changes a window work region and a horizontal or vertical ScrollBar widget to the ScrolledWindow widget + +XmScrolledWindowSetAreas + +ScrolledWindow functions +XmScrolledWindowSetAreas + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrolledW.h> + +void XmScrolledWindowSetAreas + +Widget widget +Widget horizontal_scrollbar +Widget vertical_scrollbar +Widget work_region + + + +DESCRIPTION +XmScrolledWindowSetAreas adds or changes a window work region and +a horizontal or vertical ScrollBar widget to the ScrolledWindow widget for +the application. Each widget is optional and may be passed as NULL. +This function is obsolete and exists for compatibility with +other releases. Use the XmNscrolledWindowChildType resource +of XmScrolledWindow instead. + + + +widget + +Specifies the ScrolledWindow widget ID. + + + + +horizontal_scrollbar + +Specifies the ScrollBar widget ID for the +horizontal ScrollBar to be associated +with the ScrolledWindow widget. Set this ID only after creating an instance +of the ScrolledWindow widget. The resource name associated with this +argument is XmNhorizontalScrollBar. + + + + +vertical_scrollbar + +Specifies the ScrollBar widget ID for the +vertical ScrollBar to be associated +with the ScrolledWindow widget. Set this ID only after creating an instance +of the ScrolledWindow widget. The resource name associated with this +argument is XmNverticalScrollBar. + + + + +work_region + +Specifies the widget ID for the work window to be associated with the +ScrolledWindow widget. Set this ID only after creating an instance of the +ScrolledWindow widget. The attribute name associated with this argument is +XmNworkWindow. + + + + +For a complete definition of ScrolledWindow and its associated resources, see +&cdeman.XmScrolledWindow;. + + + +RELATED +&cdeman.XmScrolledWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBA.sgm new file mode 100644 index 00000000..d19d806c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBA.sgm @@ -0,0 +1,1601 @@ + + + + + + + + + + + +XmScrollBar +library call + + +XmScrollBar +The ScrollBar widget class + +XmScrollBar + +widget class +ScrollBar + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/ScrollBar.h> + + + +DESCRIPTION +The ScrollBar widget allows the user to view data that is too large to be +displayed all at once. ScrollBars are usually located inside a +ScrolledWindow and adjacent to +the widget that contains the data to be viewed. When the user interacts +with the ScrollBar, the data within the other widget scrolls. + +A ScrollBar consists of two arrows placed at each end of a rectangle. The +rectangle is called the scroll region. A smaller rectangle, called the +slider, is placed within the scroll region. The data is scrolled by +clicking either arrow, selecting on the scroll region, or dragging the slider. +When an arrow is selected, the slider within the scroll region is +moved in the direction of the arrow by an amount supplied by the +application. If the mouse button is held down, the slider continues to +move at a constant rate. + +The ratio of the slider size to the scroll region size typically +corresponds to the +relationship between the size of the visible data and the total size +of the data. For example, if 10 percent of the data is visible, the +slider typically occupies 10 percent of the scroll region. This provides the +user with a visual clue to the size of the invisible data. + +If the ScrollBar parent is an automatic ScrolledWindow, the +XmNtraversalOn default is True. Otherwise, the default is False. + +ScrollBar holds the XmQTnavigator traits. + + +Classes +ScrollBar inherits behavior, resources, and traits from the Core and +XmPrimitive classes. + +The class pointer is xmScrollBarWidgetClass. + +The class name is XmScrollBar. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmScrollBar Resource Set + + +Name +Class +Type +Default +Access + + +XmNdecrementCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNdragCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNeditable +XmCEditable +Boolean +True +CSG + + +XmNincrement +XmCIncrement +int +1 +CSG + + +XmNincrementCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNinitialDelay +XmCInitialDelay +int +250 ms +CSG + + +XmNmaximum +XmCMaximum +int +100 +CSG + + +XmNminimum +XmCMinimum +int +0 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmVERTICAL +CSG + + +XmNpageDecrementCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpageIncrement +XmCPageIncrement +int +10 +CSG + + +XmNpageIncrementCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNprocessingDirection +XmCProcessingDirection +unsigned char +dynamic +CSG + + +XmNrepeatDelay +XmCRepeatDelay +int +50 ms +CSG + + +XmNshowArrows +XmCShowArrows +XtEnum +XmEACH_SIDE +CSG + + +XmNsliderSize +XmCSliderSize +int +dynamic +CSG + + +XmNsliderMark +XmCSliderMark +XtEnum +dynamic +CSG + + +XmNsliderVisual +XmCSliderVisual +XtEnum +XmSHADOWED +CSG + + +XmNslidingMode +XmCSlidingMode +XtEnum +XmSLIDER +CSG + + +XmNsnapBackMultiple +XmCSnapBackMultiple +unsigned short +MaxValue +CSG + + +XmNtoBottomCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNtoTopCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNtroughColor +XmCTroughColor +Pixel +dynamic +CSG + + +XmNvalue +XmCValue +int +dynamic +CSG + + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +XmNdecrementCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the ScrollBar by one increment and the value +decreases. +The reason passed to the callback is XmCR_DECREMENT. + + + + +XmNdragCallback + +Specifies the list of callbacks that is called +on each incremental change of position +when the slider is being dragged. The reason sent by the +callback is XmCR_DRAG. + + + + +XmNeditable + +Specifies how ScrollBar will react to user input. This +resource can be True or False values, as follows: + + + +True + +Allows the scrollbar to be sensitive to user input. This is the +default value. + + + + +False + +Makes the Scale scrollbar insensitive to user input. The visual is not +greyed out. This value would mostly be used in XmTHERMOMETER +mode. + + + + + +When XmNeditable is used on a widget +it sets the dropsite to XmDROP_SITE_ACTIVE. + + + + +XmNincrement + +Specifies the amount by which the value increases or decreases when the +user takes an action that moves the slider by one increment. +The actual change in value is the lesser of XmNincrement and +(previous XmNvalue − XmNminimum) when the slider moves to +the end of the ScrollBar with the minimum value, +and the lesser of XmNincrement +and (XmNmaximum− XmNsliderSize − +previous XmNvalue) when the slider moves to the end of the +ScrollBar with the maximum value. +The value of this resource must be greater than 0 (zero). + + + + +XmNincrementCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the ScrollBar by one increment and the value +increases. +The reason passed to the callback is XmCR_INCREMENT. + + + + +XmNinitialDelay + +Specifies the amount of time in milliseconds to wait before starting +continuous +slider movement while a button is pressed in an arrow or the scroll region. +The value of this resource must be greater than 0 (zero). + + + + +XmNmaximum + +Specifies the slider's maximum value. +XmNmaximum must be greater than XmNminimum. + + + + +XmNminimum + +Specifies the slider's minimum value. +XmNmaximum must be greater than XmNminimum. + + + + +XmNorientation + +Specifies whether the ScrollBar is displayed vertically or horizontally. +This resource can have values of XmVERTICAL and XmHORIZONTAL. + + + + +XmNpageDecrementCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the ScrollBar by one page increment and the value +decreases. +The reason passed to the callback is XmCR_PAGE_DECREMENT. + + + + +XmNpageIncrement + +Specifies the amount by which the value increases or decreases when +the user takes an action that moves the slider by one page increment. +The actual change in value is the lesser of XmNpageIncrement and +(previous XmNvalue − XmNminimum) when the slider moves to +the end of the ScrollBar with the +minimum value, and the lesser of +XmNpageIncrement and (XmNmaximum− XmNsliderSize − +previous XmNvalue) when the slider moves to the end of the +ScrollBar with the maximum value. +The value of this resource must be greater than 0 (zero). + + + + +XmNpageIncrementCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the ScrollBar by one page increment and the value +increases. +The reason passed to the callback is XmCR_PAGE_INCREMENT. + + + + +XmNprocessingDirection + +Specifies whether the value for XmNmaximum should be on the right or +left side of XmNminimum for horizontal ScrollBars +or above or below XmNminimum for vertical ScrollBars. +This resource can have values of XmMAX_ON_TOP, XmMAX_ON_BOTTOM, +XmMAX_ON_LEFT, and XmMAX_ON_RIGHT. +If the ScrollBar is oriented vertically, +the default value is +XmMAX_ON_BOTTOM. +If the ScrollBar is oriented horizontally, +the default value +depends on the XmNlayoutDirection resource of the widget. + + + + +XmNrepeatDelay + +Specifies the amount of time in milliseconds to wait between +subsequent slider movements after the XmNinitialDelay has been processed. +The value of this resource must be greater than 0 (zero). + + + + +XmNshowArrows + +Specifies whether the arrows are +displayed and how they are to be displayed. This resource can take the +following values: + + + +XmEACH_SIDE + +Indicates that one arrow is displayed on each end of the ScrollBar +slider. This corresponds to a value of True in previous releases. + + + + +XmMAX_SIDE + +Indicates that both arrows are displayed on the XmNmaximum side of +the ScrollBar slider. + + + + +XmMIN_SIDE + +Indicates that both arrows are displayed on the XmNminimum side of +the ScrollBar slider. + + + + +XmNONE + +Indicates that no arrows are displayed. This corresponds to a value +of False in previous releases. + + + + +XmEACH_SIDE is the default value. + + + + +XmNsliderMark + +Specifies the shape the slider is to be displayed in. This resource +can take the following values: + + + +XmETCHED_LINE + +Specifies the slider as an etched line. + + + + +XmNONE + +Specifies the slider as a foregrounded rectangle. This is the default +for a regular slider. + + + + +XmROUND_MARK + +Specifies the slider as a shadowed circle. This is the default when +the slider is a thermometer. + + + + +XmTHUMB_MARK + +Specifies the slider as a series of three etched lines centered in the +middle of the slider. + + + + + + + +XmNslidingMode + +Specifies the mode the slider works in. There are two possible modes: + + + +XmSLIDER + +Allows the slider to move freely between the minimum and maximum ends +of the scale. This is the default value. + + + + +XmTHERMOMETER + +Forces the slider to be anchored to one side of the trough area. + + + + + + + +XmNsliderSize + +Specifies the length of the slider between the values of 1 and +(XmNmaximum − XmNminimum). +The value is constrained to be within these inclusive bounds. +The default value is (XmNmaximum − XmNminimum) divided by +10, with a minimum of 1. + + + + +XmNsliderVisual + +Specifies the color of the slider visual. This resource can take +the following values: + + + +XmBACKGROUND_COLOR + +Specifies that the slider visual is in the background color. + + + + +XmFOREGROUND_COLOR + +Specifies that the slider visual is in the foreground color. + + + + +XmSHADOWED_BACKGROUND + +Specifies that the slider visual is in the background color, with a shadow. +This is the +default for a regular slider. + + + + +XmTROUGH_COLOR + +Specifies that the slider visual is in the trough color. This is the +default when the slider is a thermometer. + + + + + + + +XmNsnapBackMultiple + +Specifies the distance over which the scrollbar slider snaps back to its +original position when the user drags the mouse outside the ScrollBar +edge. This distance is defined in terms of multiples of +the width of the slider. For example, a multiple of 0 (zero) causes the +slider to snap back as soon as the pointer moves out of the ScrollBar +frame, a multiple of 1 causes the slider to snap back as soon as the +pointer moves beyond 1 ScrollBar width of the ScrollBar edge. +Whenever the slider snaps back, the ScrollBar dragCallback is +called if there is one. + +The default value is large enough to prevent unwanted snapBack +activity if the mouse is moved within the boundaries of any reasonable +screen. To reset the default, set this resource to a large value, +such as 10000. + + + + +XmNtoBottomCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the slider to the end of the ScrollBar with the +maximum value. +The reason passed to the callback is XmCR_TO_BOTTOM. + + + + +XmNtoTopCallback + +Specifies the list of callbacks that is called when the user takes an +action that moves the slider to the end of the ScrollBar with the +minimum value. +The reason passed to the callback is XmCR_TO_TOP. + + + + +XmNtroughColor + +Specifies the color of the slider trough. +This color defaults to the color used for selections. + + + + +XmNvalue + +Specifies the slider's position, between XmNminimum and +(XmNmaximum − XmNsliderSize). +The value is constrained to be within these inclusive bounds. +The initial value of this resource is the larger of 0 (zero) and XmNminimum. + + + + +XmNvalueChangedCallback + +Specifies the list of callbacks that is called when the slider is +released after being dragged. +These callbacks are also called in place of XmNincrementCallback, +XmNdecrementCallback, XmNpageIncrementCallback, +XmNpageDecrementCallback, XmNtoTopCallback, or +XmNtoBottomCallback when one of these callback lists would +normally be called but the value of the corresponding resource is NULL. +The reason passed to the callback is XmCR_VALUE_CHANGED. + + + + + + +Inherited Resources +ScrollBar inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +dynamic +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmSTICKY_TAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +dynamic +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int value; + int pixel; +} XmScrollBarCallbackStruct; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. + + + + +value + +Contains the new slider location value. + + + + +pixel + +Is used only for XmNtoTopCallback and XmNtoBottomCallback. +For horizontal ScrollBars, it contains the x coordinate of where +the mouse button selection occurred. For vertical ScrollBars, it +contains the y coordinate. + + + + + + + + + + + + + + + + +Translations +XmScrollBar includes translations from Primitive. +The XmScrollBar translations are described in the following +list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +≈s ≈c ≈m ≈a Btn1Down: + +Select() + + + + +≈s ≈c ≈m ≈a Btn1Up: + +Release() + + + + +≈s ≈c ≈m ≈a Button1PtrMoved: + +Moved() + + + + +≈s ≈c ≈m ≈a Btn2Down: + +Select() + + + + +≈s ≈c ≈m ≈a Btn2Up: + +Release() + + + + +≈s ≈c ≈m ≈a Button2PtrMoved: + +Moved() + + + + +≈s c ≈m ≈a Btn1Down: + +TopOrBottom() + + + + +≈s c ≈m ≈a Btn1Up: + +Release() + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +CancelDrag() + + + + +:KeyosfBeginLine: + +TopOrBottom() + + + + +:KeyosfEndLine: + +TopOrBottom() + + + + +:KeyosfPageLeft: + +PageUpOrLeft(Left) + + + + +:c KeyosfPageUp: + +PageUpOrLeft(Left) + + + + +:KeyosfPageUp: + +PageUpOrLeft(Up) + + + + +:KeyosfPageRight: + +PageDownOrRight(Right) + + + + +:c KeyosfPageDown: + +PageDownOrRight(Right) + + + + +:KeyosfPageDown: + +PageDownOrRight(Down) + + + + +:KeyosfHelp: + +PrimitiveHelp() + + + + +:c KeyosfUp: + +PageUpOrLeft(Up) + + + + +:KeyosfUp: + +IncrementUpOrLeft(Up) + + + + +:c KeyosfDown: + +PageDownOrRight(Down) + + + + +:KeyosfDown: + +IncrementDownOrRight(Down) + + + + +:c KeyosfLeft: + +PageUpOrLeft(Left) + + + + +:KeyosfLeft: + +IncrementUpOrLeft(Left) + + + + +:c KeyosfRight: + +PageDownOrRight(Right) + + + + +:KeyosfRight: + +IncrementDownOrRight(Right) + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +s ≈m ≈a KeyTab: + +PrimitivePrevTabGroup() + + + + +≈m ≈a KeyTab: + +PrimitiveNextTabGroup() + + + + + + + + +Action Routines +The ScrollBar action routines are + + + +CancelDrag(): + +If the key press occurs during scrolling, cancels the +scroll and returns the slider to its previous location in the scrollbar, +otherwise, and if the parent is a manager, it passes the event to +the parent. + + + + +IncrementDownOrRight(Down|Right): + +With an argument of Down, or 0 (zero) for compatibility, moves +the slider down by one increment. +With an argument of Right, or 1 for compatibility, it moves the +slider right by one increment. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, movement toward the right or +bottom calls the callbacks for XmNincrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom calls the callbacks for XmNdecrementCallback. +The XmNvalueChangedCallback is called if the +XmNincrementCallback or XmNdecrementCallback is NULL. + + + + +IncrementUpOrLeft(Up|Left): + +With an argument of Up, or 0 (zero) for compatibility, moves the +slider up by one increment. +With an argument of Left, or 1 for compatibility, it moves the +slider left by one increment. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, +movement to the left or top calls the callbacks for +XmNdecrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, +movement to the left or top calls the callbacks for +XmNincrementCallback. +The XmNvalueChangedCallback is called if the +XmNincrementCallback or XmNdecrementCallback is NULL. + + + + +Moved(): + +If the button press occurs within the slider, the subsequent motion +events move the slider to the position of the pointer and call the +callbacks for XmNdragCallback. + + + + +PageDownOrRight(Down|Right): + +With an argument of Down, or 0 (zero) for compatibility, moves +the slider down by one page increment. +With an argument of Right, or 1 for compatibility, moves the +slider right by one page increment. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, movement toward the right or +bottom calls the callbacks for XmNpageIncrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom calls the XmNpageDecrementCallback +callbacks. The XmNvalueChangedCallback is called if the +XmNpageIncrementCallback or XmNpageDecrementCallback is NULL. + + + + +PageUpOrLeft(Up|Left): + +With an argument of Up, or 0 (zero) for compatibility, moves the +slider up by one page increment. +With an argument of Left, or 1 for compatibility, it moves the +slider left by one page increment. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, +movement to the left or top calls the callbacks for +XmNpageDecrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, +movement to the left or top calls the +XmNpageIncrementCallback +callbacks. The XmNvalueChangedCallback is called if the +XmNpageIncrementCallback or XmNpageDecrementCallback is NULL. + + + + +PrimitiveHelp(): + +Calls the callbacks for XmNhelpCallback if any exist. If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +PrimitiveNextTabGroup(): + +Traverses to the first item in the next tab group. If +the current tab group is the last entry in the tab group list, it +wraps to the beginning of the tab group list. + + + + +PrimitiveParentActivate(): + +If the parent is a manager, +passes the event to the parent. + + + + +PrimitivePrevTabGroup(): + +Traverses to the first item in the previous tab group. +If the beginning of the tab group list is reached, it wraps to the end +of the tab group list. + + + + +Release(): + +If the button press occurs within the slider and the slider position +is changed, the callbacks for XmNvalueChangedCallback are called. + + + + +Select(): + +In arrow: +Moves the slider by one increment in the direction +of the arrow. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, movement toward the right or +bottom calls the callbacks for XmNincrementCallback, +and movement to the left or top calls the callbacks for +XmNdecrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom calls the callbacks for XmNdecrementCallback, +and movement to the left or top calls the callbacks for +XmNincrementCallback. +The XmNvalueChangedCallback is called if the +XmNincrementCallback or XmNdecrementCallback is NULL. + +In scroll region between an arrow and the slider: +Moves the slider by one page increment in the direction of the arrow. +If XmNprocessingDirection is XmMAX_ON_RIGHT or +XmMAX_ON_BOTTOM, movement toward the right or +bottom calls the callbacks for XmNpageIncrementCallback, +and movement to the left or top calls the callbacks for +XmNpageDecrementCallback. +If XmNprocessingDirection is XmMAX_ON_LEFT or +XmMAX_ON_TOP, movement toward the right or +bottom calls the callbacks for XmNpageDecrementCallback, +and movement to the left or top calls the callbacks for +XmNpageIncrementCallback. +The XmNvalueChangedCallback is called if the +XmNpageIncrementCallback or XmNpageDecrementCallback is +NULL. + +In slider: +Activates the interactive dragging of the slider. + +If the button is held down in either the arrows or the scroll region +longer than the XmNinitialDelay resource, the slider is +moved again by the same increment and the same callbacks are called. +After the initial delay has been used, the time delay changes to the +time defined by the resource XmNrepeatDelay. + + + + +TopOrBottom(): + +CtrlBtn1Down in an arrow or in the scroll region between +an arrow and the slider moves the slider as far as possible in the +direction of the arrow. If XmNprocessingDirection is +XmMAX_ON_RIGHT or XmMAX_ON_BOTTOM, movement toward the +right or bottom calls the callbacks for XmNtoBottomCallback, and +movement to the left or top calls the callbacks for +XmNtoTopCallback. If XmNprocessingDirection is +XmMAX_ON_LEFT or XmMAX_ON_TOP, movement toward the right +or bottom calls the callbacks for XmNtoTopCallback, and movement +to the left or top calls the callbacks for XmNtoBottomCallback. +The XmNvalueChangedCallback is called if the +XmNtoTopCallback or XmNtoBottomCallback is NULL. +Pressing +KeyosfBeginLine or KeyosfBeginData moves the slider to +the minimum value and invokes the XmNtoTopCallback. Pressing +KeyosfEndLine or KeyosfEndData moves the slider to the +maximum value and invokes the XmNtoBottomCallback. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCreateScrollBar;, &cdeman.XmPrimitive;, +&cdeman.XmScrollBarGetValues;, and +&cdeman.XmScrollBarSetValues;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBB.sgm new file mode 100644 index 00000000..eb7742e5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBB.sgm @@ -0,0 +1,124 @@ + + + + + + + + + + + +XmScrollBarGetValues +library call + + +XmScrollBarGetValues +A ScrollBar function that returns the ScrollBar's increment values + +XmScrollBarGetValues + +ScrollBar functions +XmScrollBarGetValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrollBar.h> +void XmScrollBarGetValues (widget, value_return, slider_size_return, +increment_return, page_increment_return) + Widget widget; + int * value_return; + int * slider_size_return; + int * increment_return; + int * page_increment_return; + + + + + + +DESCRIPTION +XmScrollBarGetValues returns the +the ScrollBar's increment values. +The scroll region is overlaid with a +slider bar that is adjusted in size and position using the main ScrollBar or +set slider function attributes. + + + +widget + +Specifies the ScrollBar widget ID. + + + + +value_return + +Returns the ScrollBar's slider position between the +XmNminimum and XmNmaximum resources. +Specify NULL to prevent the return of a particular value. + + + + +slider_size_return + +Returns the size of the slider as a value between 0 (zero) and the absolute +value of XmNmaximum minus XmNminimum. The size of the slider +varies, depending on how much of the slider scroll area it represents. + + + + +increment_return + +Returns the amount of increment and decrement. + + + + +page_increment_return + +Returns the amount of page increment and decrement. + + + + +For a complete definition of ScrollBar and its associated resources, see +&cdeman.XmScrollBar;. + + + +RETURN +Returns the ScrollBar's increment values. + + + +RELATED +&cdeman.XmScrollBar;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBC.sgm new file mode 100644 index 00000000..35365411 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollBC.sgm @@ -0,0 +1,143 @@ + + + + + + + + + + + +XmScrollBarSetValues +library call + + +XmScrollBarSetValues +A ScrollBar function that changes ScrollBar's increment values and the slider's size and position + +XmScrollBarSetValues + +ScrollBar functions +XmScrollBarSetValues + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrollBar.h> +void XmScrollBarSetValues (widget, value, slider_size, increment, page_increment, +notify) + Widget widget; + int value; + int slider_size; + int increment; + int page_increment; + Boolean notify; + + + + + + +DESCRIPTION +XmSetScrollBarValues changes the ScrollBar's increment values and the +slider's size and position. +The scroll region is overlaid with a +slider bar that is adjusted in size and position using the main ScrollBar or +set slider function attributes. + + + +widget + +Specifies the ScrollBar widget ID. + + + + +value + +Specifies the ScrollBar's slider +position. Refer to the XmNvalue resource described on +&cdeman.XmScrollBar;. + + + + +slider_size + +Specifies the size of the +slider. Refer to the XmNsliderSize resource described on +&cdeman.XmScrollBar;. This argument sets that resource. +Specify a +value of 0 (zero) if you do not want to change the value. + + + + +increment + +Specifies the amount of button increment and decrement. +Refer to the XmNincrement resource described on +&cdeman.XmScrollBar;. This argument sets that resource. +Specify a +value of 0 (zero) if you do not want to change the value. + + + + +page_increment + +Specifies the amount of page increment and decrement. +Refer to the XmNpageIncrement resource described on +&cdeman.XmScrollBar;. This argument sets that resource. +Specify a +value of 0 (zero) if you do not want to change the value. + + + + +notify + +Specifies a Boolean value that, when True, indicates a change in +the ScrollBar value and also specifies that the ScrollBar widget +automatically activates +the XmNvalueChangedCallback with the recent change. +If it is set to False, +it specifies any change that has occurred in the ScrollBar's value, but +does not activate XmNvalueChangedCallback. + + + + +For a complete definition of ScrollBar and its associated resources, see +&cdeman.XmScrollBar;. + + + +RELATED +&cdeman.XmScrollBar;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollVi.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollVi.sgm new file mode 100644 index 00000000..b6013e6a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ScrollVi.sgm @@ -0,0 +1,117 @@ + + + + + + + + + + + +XmScrollVisible +library call + + +XmScrollVisible +A ScrolledWindow function that makes an invisible + descendant of a ScrolledWindow work area visible + +XmScrollVisible + +Scrolled Window functions +XmScrollVisible + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ScrolledW.h> + +void XmScrollVisible + +Widget scrollw_widget +Widget widget +Dimension left_right_margin +Dimension top_bottom_margin + + + +DESCRIPTION +XmScrollVisible makes an obscured or partially obscured +widget or gadget descendant of a ScrolledWindow work area visible. The +function repositions the work area and sets the specified margins +between the widget and the nearest viewport boundary. The widget's +location relative to the viewport determines whether one or both +of the margins must be adjusted. This function requires that +the XmNscrollingPolicy of the ScrolledWindow widget be set +to XmAUTOMATIC. + + + +scrollw_widget + +Specifies the ID of the ScrolledWindow widget whose work area +window contains an obscured descendant. + + + + +widget + +Specifies the ID of the widget to be made visible. + + + + +left_right_margin + +Specifies the margin to establish between the left +or right edge of the widget and the associated edge of the +viewport. +This margin is established only if the widget must be moved horizontally +to make it visible. + + + + +top_bottom_margin + +Specifies the margin to establish between the top +or bottom edge of the widget and the associated edge of the +viewport. +This margin is established only if the widget must be moved vertically +to make it visible. + + + + +For a complete definition of ScrolledWindow and its associated +resources, see &cdeman.XmScrolledWindow; + + +RELATED +&cdeman.XmScrolledWindow;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectA.sgm new file mode 100644 index 00000000..8a116997 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectA.sgm @@ -0,0 +1,1555 @@ + + + + + + + + + + + +XmSelectionBox +library call + + +XmSelectionBox +The SelectionBox widget class + +XmSelectionBox + +widget class +SelectionBox + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/SelectioB.h> + + + +DESCRIPTION +SelectionBox is a general dialog widget that allows the user to +select one item from a list. +By default, a SelectionBox includes the following: + + + +A scrolling list of alternatives + + + +An editable text field for the selected alternative + + + +Labels for the list and text field + + + +Three or four buttons + + + +The default button labels are OK, Cancel, and Help. +By default an Apply button is also created; if the parent of the +SelectionBox is a DialogShell, it is managed; otherwise it is unmanaged. +Additional children may be added to the SelectionBox after +creation. +The first child is used as a work area. The value of +XmNchildPlacement determines if the work area is placed above +or below the Text area, or above or below the List area. Additional +children are laid out in the following manner: + + + +Menubar + +The first menu bar child is placed at the top of the window. +The XmQTmenuSystem trait is used to check that it is the first +MenuBar child. + + + + +Buttons + +All XmPushButton +widgets or gadgets, and their subclasses are +placed after the OK button in the order of their +creation (this order is checked using the XmQTactivatable trait). +The layout direction of the buttons depends on the +XmNlayoutDirection resource. + + + + +The layout of additional children that are not in the above categories +is undefined. + +The user can select an item in two ways: +by scrolling through the list and selecting the desired +item or by entering the item name directly into the text edit area. +Selecting an item from +the list causes that item name to appear in the selection text edit +area. + +The user may select a new item +as many times as desired. The item is not actually selected until +the user presses the OK PushButton. + +The default value for the XmBulletinBoard resource +XmNcancelButton is the Cancel button, unless XmNdialogType is +XmDIALOG_COMMAND, when the default is NULL. +The default value for the XmBulletinBoard +XmNdefaultButton resource is the OK button, unless XmNdialogType is +XmDIALOG_COMMAND, when the default is NULL. + +For SelectionBox and its subclasses, the default value for +XmNinitialFocus is the text edit area. + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of SelectionBox. The following list +identifies the names of these widgets (or gadgets) and the associated +SelectionBox areas: + + + +List Items Label + +Items + + + + +List Items + +ItemsList + + + + +Selection Label + +Selection + + + + +Selection Text + +Text or TextField + + + + +Selection Separator + +Separator + + + + +SelectionBox uses the XmQTaccessTextual, XmQTactivatable, +and XmQTmenuSystem traits. + + +Descendants +SelectionBox automatically creates the descendants shown in the +following table. +An application can use XtNameToWidget to gain access +to the named descendant. In addition, a user or an application +can use the named descendant when specifying resource values. + + + + + + + + +Named Descendant +Class +Identity + + += + + +Apply +XmPushButtonGadget +Apply button + + +Cancel +XmPushButtonGadget +Cancel button + + +Help +XmPushButtonGadget +Help button + + +Items +XmLabelGadget +title above the list of items + + +ItemsList +XmList +list of items from which the user will select + + +ItemsListSW +XmScrolledWindow +ScrolledWindow parent of ItemsList + + +OK +XmPushButtonGadget +OK button + + +Selection +XmLabelGadget +title above the selection box + + +Separator +XmSeparatorGadget +dividing line between selection box and buttons + + +Text +XmTextField +selection box containing text of selected item + + + + + + +Classes +SelectionBox inherits behavior, resources, and traits from Core, +Composite, Constraint, XmManager, +and XmBulletinBoard. + +The class pointer is xmSelectionBoxWidgetClass. + +The class name is XmSelectionBox. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmSelectionBox Resource Set + + +Name +Class +Type +Default +Access + + +XmNapplyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNapplyLabelString +XmCApplyLabelString +XmString +dynamic +CSG + + +XmNcancelCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNcancelLabelString +XmCCancelLabelString +XmString +dynamic +CSG + + +XmNchildPlacement +XmCChildPlacement +unsigned char +XmPLACE_ABOVE_SELECTION +CSG + + +XmNdialogType +XmCDialogType +unsigned char +dynamic +CG + + +XmNhelpLabelString +XmCHelpLabelString +XmString +dynamic +CSG + + +XmNlistItemCount +XmCItemCount +int +0 +CSG + + +XmNlistItems +XmCItems +XmStringTable +NULL +CSG + + +XmNlistLabelString +XmCListLabelString +XmString +dynamic +CSG + + +XmNlistVisibleItemCount +XmCVisibleItemCount +int +dynamic +CSG + + +XmNminimizeButtons +XmCMinimizeButtons +Boolean +False +CSG + + +XmNmustMatch +XmCMustMatch +Boolean +False +CSG + + +XmNnoMatchCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNokCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNokLabelString +XmCOkLabelString +XmString +dynamic +CSG + + +XmNselectionLabelString +XmCSelectionLabelString +XmString +dynamic +CSG + + +XmNtextAccelerators +XmCTextAccelerators +XtAccelerators +default +C + + +XmNtextColumns +XmCColumns +short +dynamic +CSG + + +XmNtextString +XmCTextString +XmString +"" +CSG + + + + + + +XmNapplyCallback + +Specifies the list of callbacks called +when the user activates the Apply +button. The callback reason is XmCR_APPLY. + + + + +XmNapplyLabelString + +Specifies the string label for the Apply button. +The default for this resource depends on the locale. +In the C locale the default is Apply. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNcancelCallback + +Specifies the list of callbacks called +when the user activates +the Cancel button. The callback reason is XmCR_CANCEL. + + + + +XmNcancelLabelString + +Specifies the string label for the Cancel button. +The default for this resource depends on the locale. +In the C locale the default is Cancel. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNchildPlacement + +Specifies the placement of the work area child. The +possible values are + + + +XmPLACE_ABOVE_SELECTION + +Places the work area child above the Text area + + + + +XmPLACE_BELOW_SELECTION + +Places the work area child below the Text area + + + + +XmPLACE_TOP + +Places the work area child above the List area, +and below a MenuBar, if one is present + + + + + + + +XmNdialogType + +Determines the set of SelectionBox children widgets that are created +and managed at initialization. The possible values are + + + +XmDIALOG_PROMPT + +All standard children except the list and +list label are created, and all except the Apply button are +managed + + + + +XmDIALOG_COMMAND + +Only the list, the selection label, and the +text field are created and managed + + + + +XmDIALOG_SELECTION + +All standard children are created and +managed + + + + +XmDIALOG_FILE_SELECTION + +All standard children are created and +managed + + + + +XmDIALOG_WORK_AREA + +All standard children are created, and all +except the Apply button are managed + + + + +If the parent of the SelectionBox is a DialogShell, the default is +XmDIALOG_SELECTION; otherwise, the default is XmDIALOG_WORK_AREA. +XmCreatePromptDialog and XmCreateSelectionDialog set and append +this resource to the creation arglist supplied by the application. +This resource cannot be modified after creation. + + + + +XmNhelpLabelString + +Specifies the string label for the Help button. +The default for this resource depends on the locale. +In the C locale the default is Help. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNlistItems + +Specifies the items in the SelectionBox list. +XtGetValues for this resource returns the list items themselves, +not a copy of the list items. +The application must not free the returned items. + + + + +XmNlistItemCount + +Specifies the number of items in the SelectionBox +list. +The value must not be negative. + + + + +XmNlistLabelString + +Specifies the string label to appear above the SelectionBox list +containing the selection items. +The default for this resource depends on the locale. +In the C locale the default is Items +unless XmNdialogType is +XmDIALOG_PROMPT; in this case the default is NULL. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNlistVisibleItemCount + +Specifies the number of items displayed in the SelectionBox +list. +The value must be greater than 0 (zero) unless XmNdialogType is +XmDIALOG_PROMPT; in this case, the value is always 0. +The default is dynamic based on the height of the list. + + + + +XmNminimizeButtons + +Sets the buttons to the width of the widest button and height of the +tallest button if False. If True, button width and height are not +modified. + + + + +XmNmustMatch + +Specifies whether the selection widget should check if the +user's selection in the text edit field has an exact match in +the SelectionBox list when the OK button is activated. +If the selection does not have an exact match, and +XmNmustMatch is True, the XmNnoMatchCallback callbacks are +called. +If the selection does have an exact match or if XmNmustMatch is +False, XmNokCallback callbacks are called. + + + + +XmNnoMatchCallback + +Specifies the list of callbacks called +when the user makes a selection +from the text edit field that does not have an exact match with +any of the items in the list box. +The callback reason is XmCR_NO_MATCH. +Callbacks in this list are called only if XmNmustMatch +is true. + + + + +XmNokCallback + +Specifies the list of callbacks called +when the user activates the OK button. +The callback reason is XmCR_OK. +If the selection text does not match a list item, and +XmNmustMatch is True, the XmNnoMatchCallback callbacks are +called instead. + + + + +XmNokLabelString + +Specifies the string label for the OK button. +The default for this resource depends on the locale. +In the C locale the default is OK. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNselectionLabelString + +Specifies the string label for the selection text edit field. +The default for this resource depends on the locale. +In the C locale the default is Selection. + + +Now that some default localized label strings are provided through +message catalogs for the children of composite widgets, the +labelString resources +cannot be set on the child through default resource files. +Instead, the resource provided at the parent level must be used. + + + + +XmNtextAccelerators + +Specifies translations added to the Text widget child of the +SelectionBox. +The default includes bindings for the up and down keys +for auto selection of list items. +This resource is ignored if XmNaccelerators is initialized to a +nondefault value. + + + + +XmNtextColumns + +Specifies the number of columns in the Text widget. +The value must be greater than 0 (zero). + + + + +XmNtextString + +Specifies the text in the text edit selection field. + + + + + + +Inherited Resources +SelectionBox inherits behavior and resources from the +superclasses in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmBulletinBoard Resource Set + + +Name +Class +Type +Default +Access + + +XmNallowOverlap +XmCAllowOverlap +Boolean +True +CSG + + +XmNautoUnmanage +XmCAutoUnmanage +Boolean +True +CG + + +XmNbuttonFontList +XmCButtonFontList +XmFontList +dynamic +CSG + + +XmNbuttonRenderTable +XmCButtonRenderTable +XmRenderTable +dynamic +CSG + + +XmNcancelButton +XmCWidget +Widget +dynamic +SG + + +XmNdefaultButton +XmCWidget +Widget +dynamic +SG + + +XmNdefaultPosition +XmCDefaultPosition +Boolean +True +CSG + + +XmNdialogStyle +XmCDialogStyle +unsigned char +dynamic +CSG + + +XmNdialogTitle +XmCDialogTitle +XmString +NULL +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlabelFontList +XmCLabelFontList +XmFontList +dynamic +CSG + + +XmNlabelRenderTable +XmCLabelRenderTable +XmRenderTable +dynamic +CSG + + +XmNmapCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +10 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +10 +CSG + + +XmNnoResize +XmCNoResize +Boolean +False +CSG + + +XmNresizePolicy +XmCResizePolicy +unsigned char +XmRESIZE_ANY +CSG + + +XmNshadowType +XmCShadowType +unsigned char +XmSHADOW_OUT +CSG + + +XmNtextFontList +XmCTextFontList +XmFontList +dynamic +CSG + + +XmNtextRenderTable +XmCTextRenderTable +XmRenderTable +dynamic +CSG + + +XmNtextTranslations +XmCTranslations +XtTranslations +NULL +C + + +XmNunmapCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + +XmManager Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Composite Resource Set + + +Name +Class +Type +Default +Access + + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +N/A + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + XmString value; + int length; +} XmSelectionBoxCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +value + +Indicates the XmString value selected by the user from the +SelectionBox list or entered into the SelectionBox text field + + + + +length + +Indicates the size in bytes of the XmString value +This member is obsolete and exists for compatibility with +earlier releases. + + + + + + + + + + + + + + + + +Translations +XmSelectionBox inherits translations from XmBulletinBoard. + + + +Accelerators +The XmNtextAccelerators are added to the Text descendant of +XmSelectionBox. +The default accelerators are described in the following list. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +:KeyosfUp: + +SelectionBoxUpOrDown(Previous) + + + + +:KeyosfDown: + +SelectionBoxUpOrDown(Next) + + + + +:KeyosfBeginLine: + +SelectionBoxUpOrDown(First) + + + + +:KeyosfEndLine: + +SelectionBoxUpOrDown(Last) + + + + +:KeyosfRestore: + +SelectionBoxRestore() + + + + +s c ≈m ≈a Keyspace: + +SelectionBoxRestore() + + + + + + + +Action Routines +The XmSelectionBox action routines are + + + +SelectionBoxUpOrDown(Previous|Next|First|Last): + +When called with an argument of Previous, or 0 (zero) for +compatibility, selects the previous +item in the +list and replaces the text with that item. + +When called with an argument of Next, or 1 for +compatibility, selects the next item in the +list and replaces the text with that item. + +When called with an argument of First, or 2 for +compatibility, selects the first item in the +list and replaces the text with that item. + +When called with an argument of Last, or 3 for +compatibility, selects the last item in the +list and replaces the text with that item. + + + + +SelectionBoxRestore(): + +Replaces the text value with the list selection. +If no item in the list is selected, clears the text. + + + + + + +Additional Behavior +The SelectionBox widget has the following additional behavior: + + + +KeyosfCancel: + +Calls the activate callbacks for the cancel button if it is sensitive. +If no cancel button exists and the parent of the SelectionBox is a manager, +passes the event to the parent. + + + + +KeyosfActivate: + +Calls the activate callbacks for the button with the keyboard focus. +If no button has the keyboard focus, calls the activate callbacks +for the default button if it is sensitive. +In a List widget or single-line Text widget, +the List or Text action associated with KeyosfActivate +is called before the SelectionBox actions associated with +KeyosfActivate. +In a multiline Text widget, any KeyosfActivate +event except KeyosfEnter calls +the Text action associated with KeyosfActivate, +then the SelectionBox actions associated with KeyosfActivate. +If no button has the focus, no default button exists, and the parent +of the SelectionBox is a manager, passes the event to the parent. + + + + +OK Button Activated: + +If XmNmustMatch is True and the text does not match an item in the +file list, calls the XmNnoMatchCallback callbacks with reason +XmCR_NO_MATCH. +Otherwise, calls the XmNokCallback callbacks with reason +XmCR_OK. + + + + +Apply Button Activated: + +Calls the XmNapplyCallback callbacks with reason XmCR_APPLY. + + + + +Cancel Button Activated: + +Calls the XmNcancelCallback callbacks with reason +XmCR_CANCEL. + + + + +Help Button Activated: + +Calls the XmNhelpCallback callbacks with reason XmCR_HELP. + + + + +MapWindow: + +Calls the callbacks for XmNmapCallback if the SelectionBox +is a child of a Dialog shell. + + + + +UnmapWindow: + +Calls the callbacks for XmNunmapCallback if the SelectionBox is +the child of a DialogShell. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Composite;, +&cdeman.Constraint;, +&cdeman.Core;, +&cdeman.XmBulletinBoard;, +&cdeman.XmCreateSelectionBox;, +&cdeman.XmCreateSelectionDialog;, +&cdeman.XmCreatePromptDialog;, +&cdeman.XmManager;, and +&cdeman.XmSelectionBoxGetChild;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectB.sgm new file mode 100644 index 00000000..4c84027d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SelectB.sgm @@ -0,0 +1,147 @@ + + + + + + + + + + + +XmSelectionBoxGetChild +library call + + +XmSelectionBoxGetChild +A SelectionBox function that is used to access a component + +XmSelectionBoxGetChild + +SelectionBox functions +XmSelectionBoxGetChild + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/SelectioB.h> + +Widget XmSelectionBoxGetChild + +Widget widget +unsigned char child + + + +DESCRIPTION +XmSelectionBoxGetChild is used to access a component within a +SelectionBox. The parameters given to the function are the SelectionBox +widget and a value indicating which component to access. + +NOTE: This routine is obsolete and exists for compatibility with previous +releases. Instead of calling XmSelectionBoxGetChild, you should +call XtNameToWidget as described in the &cdeman.XmSelectionBox; +reference page. + + + +widget + +Specifies the SelectionBox widget ID. + + + + +child + +Specifies a component within the SelectionBox. The following +values are legal for this parameter: + + + +XmDIALOG_APPLY_BUTTON + + + +XmDIALOG_CANCEL_BUTTON + + + +XmDIALOG_DEFAULT_BUTTON + + + +XmDIALOG_HELP_BUTTON + + + +XmDIALOG_LIST + + + +XmDIALOG_LIST_LABEL + + + +XmDIALOG_OK_BUTTON + + + +XmDIALOG_SELECTION_LABEL + + + +XmDIALOG_SEPARATOR + + + +XmDIALOG_TEXT + + + +XmDIALOG_WORK_AREA + + + + + + + +For a complete definition of SelectionBox and its associated resources, see +&cdeman.XmSelectionBox;. + + + +RETURN +Returns the widget ID of the specified SelectionBox component. +An application should not assume that the returned widget will be of any +particular class. + + + +RELATED +&cdeman.XmSelectionBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparA.sgm new file mode 100644 index 00000000..72203349 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparA.sgm @@ -0,0 +1,591 @@ + + + + + + + + + + + +XmSeparator +library call + + +XmSeparator +The Separator widget class + +XmSeparator + +widget class +Separator + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Separator.h> + + + +DESCRIPTION +Separator is a primitive widget that +separates items in a display. Several different +line drawing styles are provided, as well as horizontal or vertical +orientation. + +The Separator line drawing is automatically +centered within the height of the widget for a horizontal orientation +and centered within the width of the widget for a vertical orientation. +An XtSetValues with a new XmNseparatorType resizes the +widget to its minimal height (for horizontal orientation) or its +minimal width (for +vertical orientation) unless height or width is explicitly set in the +XtSetValues call. + +Separator does not draw shadows around the separator. +The Primitive resource XmNshadowThickness is used for the +Separator's thickness when XmNseparatorType is XmSHADOW_ETCHED_IN, +XmSHADOW_ETCHED_IN_DASH, XmSHADOW_ETCHED_OUT, or +XmSHADOW_ETCHED_OUT_DASH. + +Separator does not highlight and allows no traversing. The primitive +resource XmNtraversalOn is forced to False. + +The XmNseparatorType of XmNO_LINE provides an escape +to the application +programmer who needs a different style of drawing. +A pixmap the height of the widget can be created and used as the +background pixmap by building an argument list using the +XmNbackgroundPixmap +argument type as defined by Core. +Whenever the widget is redrawn, +its background is displayed containing the desired separator drawing. +Separator holds the XmQTmenuSavvy trait. + + +Classes +Separator inherits behavior, resources, and traits from Core +and XmPrimitive. + +The class pointer is xmSeparatorWidgetClass. + +The class name is XmSeparator. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix anduse the remaining letters (in either lowercase or uppercase, +but include any underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmSeparator Resource Set + + +Name +Class +Type +Default +Access + + +XmNmargin +XmCMargin +Dimension +0 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmHORIZONTAL +CSG + + +XmNseparatorType +XmCSeparatorType +unsigned char +XmSHADOW_ETCHED_IN +CSG + + + + + + +XmNmargin + +For horizontal orientation, specifies the space on the left and right +sides between the border of the Separator and the line drawn. +For vertical orientation, specifies the space on the top and +bottom between the border of the Separator and the line drawn. + + + + +XmNorientation + +Displays Separator vertically or horizontally. +This resource can have values of XmVERTICAL and XmHORIZONTAL. + + + + +XmNseparatorType + +Specifies the type of line drawing to be done in the Separator widget. + + + +XmSINGLE_LINE + +Single line + + + + +XmDOUBLE_LINE + +Double line + + + + +XmSINGLE_DASHED_LINE + +Single-dashed line + + + + +XmDOUBLE_DASHED_LINE + +Double-dashed line + + + + +XmNO_LINE + +No line + + + + +XmSHADOW_ETCHED_IN + +A line whose shadows give the +effect of a line etched into the window. The thickness of the +line is equal to the value of XmNshadowThickness. For +horizontal orientation, the top shadow is drawn in XmNtopShadowColor +and the bottom shadow is drawn in XmNbottomShadowColor. For +vertical orientation, the left edge is drawn in XmNtopShadowColor +and the right edge is drawn in XmNbottomShadowColor. + + + + +XmSHADOW_ETCHED_OUT + +A line whose shadows give the effect +of an etched line coming out of the window. The thickness of the +line is equal to the value of XmNshadowThickness. For horizontal +orientation, the top shadow is drawn in XmNbottomShadowColor and +the bottom shadow is drawn in XmNtopShadowColor. For vertical +orientation, the left edge is drawn in XmNbottomShadowColor and +the right edge is drawn in XmNtopShadowColor. + + + + +XmSHADOW_ETCHED_IN_DASH + +Identical to +XmSHADOW_ETCHED_IN except a series of lines creates a dashed line. + + + + +XmSHADOW_ETCHED_OUT_DASH + +Identical to +XmSHADOW_ETCHED_OUT except a series of lines creates a dashed line. + + + + + + + + + +Inherited Resources +Separator inherits behavior and resources from the +superclasses in the following table. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +False +G + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + + + +Translations +There are no translations for XmSeparator. + + + + +RELATED +&cdeman.Core;, &cdeman.XmCreateSeparator;, +and &cdeman.XmPrimitive;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparB.sgm new file mode 100644 index 00000000..9fbca385 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SeparB.sgm @@ -0,0 +1,533 @@ + + + + + + + + + + + +XmSeparatorGadget +library call + + +XmSeparatorGadget +The SeparatorGadget widget class + +XmSeparatorGadget + +widget class +SeparatorGadget + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/SeparatoG.h> + + + +DESCRIPTION +SeparatorGadget separates items in a display. +Several +line drawing styles are provided, as well as horizontal or vertical +orientation. + +Lines drawn within the SeparatorGadget are automatically +centered within the height of the gadget for a horizontal orientation +and centered within the width of the gadget for a vertical orientation. +An XtSetValues with a new XmNseparatorType resizes the +widget to its minimal height (for horizontal orientation) or its +minimal width (for +vertical orientation) unless height or width is explicitly set in the +XtSetValues call. + +SeparatorGadget does not draw shadows around the separator. +The Gadget resource XmNshadowThickness is used for the +SeparatorGadget's thickness when XmNseparatorType is +XmSHADOW_ETCHED_IN, XmSHADOW_ETCHED_IN_DASH, +XmSHADOW_ETCHED_OUT, or XmSHADOW_ETCHED_OUT_DASH. + +SeparatorGadget does not highlight and allows no traversing. The Gadget +resource XmNtraversalOn is forced to False. +SeparatorGadget +holds the XmQTmenuSavvy trait. + + +Classes +SeparatorGadget inherits behavior, +resources, and traits from Object, RectObj, and XmGadget. + +The class pointer is xmSeparatorGadgetClass. + +The class name is XmSeparatorGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmSeparatorGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNmargin +XmCMargin +Dimension +0 +CSG + + +XmNorientation +XmCOrientation +unsigned char +XmHORIZONTAL +CSG + + +XmNseparatorType +XmCSeparatorType +unsigned char +XmSHADOW_ETCHED_IN +CSG + + + + + + +XmNmargin + +For horizontal orientation, specifies the space on the left and right sides between the border of +SeparatorGadget and the line drawn. +For vertical +orientation, specifies the space +on the top and bottom between the border +of SeparatorGadget and the line drawn. + + + + +XmNorientation + +Specifies whether SeparatorGadget is displayed vertically or horizontally. +This resource can have values of XmVERTICAL and XmHORIZONTAL. + + + + +XmNseparatorType + +Specifies the type of line drawing to be done in the Separator widget. + + + +XmSINGLE_LINE + +Single line. + + + + +XmDOUBLE_LINE + +Double line. + + + + +XmSINGLE_DASHED_LINE + +Single-dashed line. + + + + +XmDOUBLE_DASHED_LINE + +Double-dashed line. + + + + +XmNO_LINE + +No line. + + + + +XmSHADOW_ETCHED_IN + +A line whose shadows give the +effect of a line etched into the window. The thickness of the +line is equal to the value of XmNshadowThickness. For +horizontal orientation, the top shadow is drawn in XmNtopShadowColor +and the bottom shadow is drawn in XmNbottomShadowColor. For +vertical orientation, the left edge is drawn in XmNtopShadowColor +and the right edge is drawn in XmNbottomShadowColor. + + + + +XmSHADOW_ETCHED_OUT + +A line whose shadows give the effect +of an etched line coming out of the window. The thickness of the +line is equal to the value of XmNshadowThickness. For horizontal +orientation, the top shadow is drawn in XmNbottomShadowColor and +the bottom shadow is drawn in XmNtopShadowColor. For vertical +orientation, the left edge is drawn in XmNbottomShadowColor and +the right edge is drawn in XmNtopShadowColor. + + + + +XmSHADOW_ETCHED_IN_DASH + +Identical to +XmSHADOW_ETCHED_IN except a series of lines creates a dashed line. + + + + +XmSHADOW_ETCHED_OUT_DASH + +Identical to +XmSHADOW_ETCHED_OUT except a series of lines creates a dashed line. + + + + + + + + + +Inherited Resources +SeparatorGadget inherits behavior and resources from the +superclasses in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +0 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +False +G + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + + + + + + + + + + + +Behavior +XmSeparatorGadget has no behavior. + + + + +RELATED +&cdeman.Object;, &cdeman.RectObj;, +&cdeman.XmCreateSeparatorGadget;, and +&cdeman.XmGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetColC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetColC.sgm new file mode 100644 index 00000000..ffde28d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetColC.sgm @@ -0,0 +1,153 @@ + + + + + + + + + + + +XmSetColorCalculation +library call + + +XmSetColorCalculation +A function to set the procedure used for default color calculation + +XmSetColorCalculation + +Color functions +XmSetColorCalculation + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmColorProc XmSetColorCalculation + +XmColorProc color_proc + + + +DESCRIPTION +XmSetColorCalculation sets the procedure to calculate +default colors. +This procedure is used to calculate the foreground, top shadow, bottom +shadow, and select colors on the basis of a given background color. +If called with an argument of NULL, it restores the default procedure +used to calculate colors. + + + +color_proc + +Specifies the procedure to use for color calculation. + + + + +Following is a description of the XmColorProc type used by +XmSetColorCalculation: + + +void (*color_proc) (background_color, foreground_color, select_color, top_shadow_color, +bottom_shadow_color) + XColor *background_color; + XColor *foreground_color; + XColor *select_color; + XColor *top_shadow_color; + XColor *bottom_shadow_color; + + + + +Specifies the procedure used to calculate default colors. +The procedure is passed a pointer to an XColor structure +representing the background color. +The pixel, red, green, and blue members of this +structure are filled in with values that are valid for the current +colormap. + +The procedure is passed pointers to XColor structures representing +the foreground, select, top shadow, and bottom shadow colors to be +calculated. +The procedure calculates and fills in the red, green, and +blue members of these structures. +The procedure should not allocate color cells for any of these colors. + + + +background_color + +Specifies the background color. + + + + +foreground_color + +Specifies the foreground color to be calculated. + + + + +select_color + +Specifies the select color to be calculated. + + + + +top_shadow_color + +Specifies the top shadow color to be calculated. + + + + +bottom_shadow_color + +Specifies the bottom shadow color to be calculated. + + + + + + +RETURN +Returns the color calculation procedure that was used at the time this +routine was called. + + + +RELATED +&cdeman.XmChangeColor;, +&cdeman.XmGetColors;, and +&cdeman.XmGetColorCalculation;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUA.sgm new file mode 100644 index 00000000..2c4415e5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUA.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmSetFontUnit +library call + + +XmSetFontUnit +A function that sets the font unit value for a display + +XmSetFontUnit + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmSetFontUnit + +Display * display +int font_unit_value + + + +DESCRIPTION +XmSetFontUnit provides an external function to initialize font unit +values. Applications may want to specify resolution-independent data based +on a global font size. +See the XmNunitType resource description in the reference pages for +XmGadget, XmManager, and XmPrimitive for more information +on resolution independence. + +This function sets the font units for all screens on the display. + +NOTE: +XmSetFontUnit is obsolete and exists for compatibility with +previous releases. +Instead of using this function, provide initial values or call +XtSetValues for the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + +display + +Defines the display for which this font unit value is to be applied. + + + + +font_unit_value + +Specifies the value to be used for both horizontal and vertical font +units in the conversion calculations. + + + + + + +RELATED +&cdeman.XmConvertUnits;, +&cdeman.XmSetFontUnits;, +&cdeman.XmGadget;, +&cdeman.XmManager;, +&cdeman.XmPrimitive;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUB.sgm new file mode 100644 index 00000000..d9d5d574 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetFonUB.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmSetFontUnits +library call + + +XmSetFontUnits +A function that sets the font unit value for a display + +XmSetFontUnits + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmSetFontUnits + +Display * display +int h_value +int v_value + + + +DESCRIPTION +XmSetFontUnits provides an external function to initialize font unit +values. Applications may want to specify resolution-independent data based +on a global font size. This function must be called before any widgets with +resolution-independent data are created. See the XmNunitType +resource description in the reference pages for +XmGadget, XmManager, and XmPrimitive for more information +on resolution independence. + +This function sets the font units for all screens on the display. + +NOTE: +XmSetFontUnits is obsolete and exists for compatibility with +previous releases. +Instead of using this function, provide initial values or call +XtSetValues for the XmScreen resources XmNhorizontalFontUnit +and XmNverticalFontUnit. + + + +display + +Defines the display for which this font unit value is to be applied. + + + + +h_value + +Specifies the value to be used for horizontal +units in the conversion calculations. + + + + +h_value + +Specifies the value to be used for vertical +units in the conversion calculations. + + + + + + +RELATED +&cdeman.XmConvertUnits;, +&cdeman.XmSetFontUnit;, +&cdeman.XmGadget;, +&cdeman.XmManager;, +&cdeman.XmPrimitive;, and +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetMenuC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetMenuC.sgm new file mode 100644 index 00000000..765b1d01 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetMenuC.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmSetMenuCursor +library call + + +XmSetMenuCursor +A function that modifies the menu cursor for a client + +XmSetMenuCursor + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmSetMenuCursor + +Display * display +Cursor cursorId + + + +DESCRIPTION +XmSetMenuCursor programmatically modifies the menu cursor for a client; +after the cursor has been created +by the client, this function registers the cursor with the menu system. After +calling this function, the specified cursor is displayed whenever +this client displays a Motif menu on the indicated display. The client can +then specify different cursors on different displays. + +This function sets the menu cursor for all screens on the display. +XmSetMenuCursor is obsolete and exists for compatibility with +previous releases. +Instead of using this function, provide initial values or call +XtSetValues for the XmScreen resource XmNmenuCursor. + + + +display + +Specifies the display to which the cursor is to be associated + + + + +cursorId + +Specifies the X cursor ID + + + + + + +RELATED +&cdeman.XmScreen;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetProto.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetProto.sgm new file mode 100644 index 00000000..617e30b2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetProto.sgm @@ -0,0 +1,142 @@ + + + + + + + + + + + +XmSetProtocolHooks +library call + + +XmSetProtocolHooks +A VendorShell function that allows preactions and postactions to be executed when a protocol message is received from MWM + +XmSetProtocolHooks + +VendorShell functions +XmSetProtocolHooks + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmSetProtocolHooks + +Widget shell +Atom property +Atom protocol +XtCallbackProc prehook +XtPointer pre_closure +XtCallbackProc posthook +XtPointer post_closure + + + +DESCRIPTION +XmSetProtocolHooks is used by shells that want to have preactions +and postactions +executed when a protocol message is received from MWM. +Since there is no guaranteed ordering in execution of event handlers or +callback lists, this allows the shell to control the flow while leaving the +protocol manager structures opaque. + +XmSetWMProtocolHooks is a convenience interface. +It calls XmSetProtocolHooks +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +property + +Specifies the protocol property + + + + +protocol + +Specifies the protocol atom + + + + +prehook + +Specifies the procedure to call before calling entries on the client callback +list + + + + +pre_closure + +Specifies the client data to be passed to the prehook when it is invoked + + + + +posthook + +Specifies the procedure to call after calling entries on the client callback +list + + + + +post_closure + +Specifies the client data to be passed to the posthook when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmInternAtom;, and &cdeman.XmSetWMProtocolHooks;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetWMPro.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetWMPro.sgm new file mode 100644 index 00000000..26cfb346 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SetWMPro.sgm @@ -0,0 +1,127 @@ + + + + + + + + + + + +XmSetWMProtocolHooks +library call + + +XmSetWMProtocolHooks +A VendorShell convenience interface that allows preactions and postactions to be executed when a protocol message is received from the window manager + +XmSetWMProtocolHooks + +VendorShell functions +XmSetWMProtocolHooks + +protocols + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> +#include <Xm/Protocols.h> + +void XmSetWMProtocolHooks + +Widget shell +Atom protocol +XtCallbackProc prehook +XtPointer pre_closure +XtCallbackProc posthook +XtPointer post_closure + + + +DESCRIPTION +XmSetWMProtocolHooks is a convenience interface. +It calls XmSetProtocolHooks +with the property value set to the atom returned by +interning WM_PROTOCOLS. + + + +shell + +Specifies the widget with which the protocol property is associated + + + + +protocol + +Specifies the protocol atom (or an int cast to Atom) + + + + +prehook + +Specifies the procedure to call before calling entries on the client callback +list + + + + +pre_closure + +Specifies the client data to be passed to the prehook when it is invoked + + + + +posthook + +Specifies the procedure to call after calling entries on the client callback +list + + + + +post_closure + +Specifies the client data to be passed to the posthook when it is invoked + + + + +For a complete definition of VendorShell and its associated resources, see +&cdeman.VendorShell;. + + + +RELATED +&cdeman.VendorShell;, +&cdeman.XmInternAtom;, and &cdeman.XmSetProtocolHooks;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBox.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBox.sgm new file mode 100644 index 00000000..63526d7f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBox.sgm @@ -0,0 +1,1471 @@ + + + + + + + + + +XmSpinBoxlibrary call + +XmSpinBox +The SpinBox widget class XmSpinBox +widget classSpinBox + + +#include <Xm/SpinB.h> + + +DESCRIPTION +SpinBox allows the user to select a value from a ring of related but +mutually exclusive choices which are displayed in sequence. The SpinBox always +has an increment arrow, a decrement arrow, and one or more other children. +The choices are displayed, one at a time, in a traversable text child ( XmText or XmTextField. The user clicks Btn1 on an arrow to display the next (or previous) item in the ring +of choices. By pressing and holding Btn1 on an arrow, the +user continuously cycles through the choices. +The traversable children in a SpinBox can be of type XmNUMERIC or XmSTRING, +as defined by the XmNspinBoxChildType +constraint resource. The ring of choices for numeric children is defined +by minimum, maximum, incremental, and decimal point values. The ring of choices +for string children is defined in an array of compound strings. +The application programmer can include multiple traversable children +in the SpinBox. For example, a SpinBox might consist of a pair of arrows +and month, day, and year text fields. The arrows only spin the child that +currently has focus. +Arrow size is specified by the SpinBox resource XmNarrowSize. This value sets both width and height of each +arrow in pixels. +The programmer can display SpinBox arrows in one of several layouts, +as specified by the XmNarrowLayout +resource: + +XmARROWS_BEGINNING + +Places a pair of left and right arrows before the children. + + +XmARROWS_END + +Places a pair of left and right arrows after the children. + + +XmARROWS_SPLIT + +Places one arrow on each side of the children. + + +XmARROWS_FLAT_BEGINNING + +Places a pair of arrows side by side before the XmSpinBox +children. + + +XmARROWS_FLAT_BEGINNING + +Places a pair of arrows side by side after the XmSpinBox +children. + + + +Positions for XmARROWS_BEGINNING +and XmARROWS_END are dependent on +the VendorShell resource XmNlayoutDirection. When layout direction is left-to-right, beginning +arrows are positioned to the left of the children. When layout direction +is right-to-left, beginning arrows are positioned to the right. +The actions of the arrows are determined by the VendorShell resource XmNlayoutDirection. +For left-to-right layouts, the right arrow is the increment arrow and the +left arrow is the decrement arrow. For right-to-left layouts, the right +arrow is the decrement arrow and the left arrow is the increment arrow. +For a numeric type child, the increment arrow increases the displayed +value by the incremental value up to the maximum. The decrement arrow decreases +the displayed value by the given incremental value down to the minimum. +The increment arrow for a string type child moves toward the last entry +of the array of compound strings (by increasing the SpinBox constraint resource +XmNposition). The decrement arrow +moves toward the first entry of the compound string array. +The programmer can also control the sensitivity of each arrow in the +SpinBox. Sensitive arrows spin choices; insensitive arrows do not spin choices. +Arrow sensitivity is set for the SpinBox widget by using the XmNdefaultArrowSensitivity resource, but it +can be modified on a per child basis by using the XmNarrowSensitivity constraint resource. +SpinBox provides two callbacks to application programmers. (In addition, +the callbacks of the SpinBox's children may be invoked.) Each of these callbacks +receives a pointer to XmSpinBoxCallbackStruct. +The XmNmodifyVerifyCallback procedures +are called before a new choice is displayed. +The XmNvalueChangedCallback procedures +are called after a new choice is displayed. + +XmNmodifyVerifyCallback tells +the application what the new position will be in the ring of choices. This +callback can be used to make the SpinBox stop at the upper and lower limits +or go to a different, nonconsecutive choice. The application allows the +change in position by leaving the doit member +set to True. The application can spin to a position other than the next +consecutive position by leaving doit set +to True and by changing the position member +to the desired position. When doit is set +to False by an application, there is no change in the choice displayed. + +After a new choice is displayed, the XmNvalueChangedCallback procedure is called. The application +can use this procedure to perform tasks when specific values are reached +or when boundaries are crossed. For example, if the user spins from January +back to December, the application could change to the previous year. If +the user spins from December to January, the application could change to +the next year. +SpinBox dimensions can be set using the Core resources XmNheight and XmNwidth. If dimensions are not specified, the SpinBox size +is determined by the sizes of its arrows and children. The SpinBox will +attempt to grow so that the arrows and all children are visible. +SpinBox uses the XmQTaccessTextual +trait and holds the XmQTnavigator trait. + + +Classes +SpinBox inherits behavior, resources, and traits from the Core, Composite, Constraint, and XmManager classes. +The class pointer is xmSpinBoxWidgetClass. + +The class name is XmSpinBox. + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a resource +by name or by class in a .Xdefaults file, remove the XmN or XmC +prefix and use the remaining letters. To specify one of the defined values +for a resource in a .Xdefaults file, remove the Xm prefix and use the remaining letters (in +either lowercase or uppercase, but include any underscores between words). +The codes in the access column indicate whether the given resource can be +set at creation time (C), set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable +(N/A). + + + + + + + + + + +XmSpinBox Resource +Set + +Name +Class +Type +Default +Access + +XmNarrowLayout +XmCArrowLayout +unsigned char +XmARROWS_BEGINNING +CSG + +XmNarrowOrientation +XmCArrowOrientation +unsigned char +XmARROWS_VERTICAL +CSG + +XmNarrowSize +XmCArrowSize +Dimension +16 +CSG + +XmNdefaultArrowSensitivity +XmCDefaultArrowSensitivity +unsigned char +XmARROWS_SENSITIVE +CSG + +XmNdetailShadowThickness +XmCDetailShadowThickness +Dimension +2 +CSG + +XmNinitialDelay +XmCInitialDelay +unsigned int +250 ms +CSG + +XmNmarginHeight +XmCMarginHeight +Dimension +dynamic +CSG + +XmNmarginWidth +XmCMarginWidth +Dimension +dynamic +CSG + +XmNmodifyVerifyCallback +XmCCallback +XtCallbackList +NULL +C + +XmNrepeatDelay +XmCRepeatDelay +unsigned int +200 ms +CSG + +XmNspacing +XmCSpacing +Dimension +dynamic +CSG + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + +XmNarrowLayout + +Specifies placement of the two arrows in the widget. Possible layouts +are as follows: + +XmARROWS_BEGINNING + +Places left and right arrows beside each other, before the child(ren). +Positioning for this layout is dependent on the VendorShell resource XmNlayoutDirection. + + +XmARROWS_END + +Places left and right arrows beside each other, after the child(ren). +Positioning for this layout is dependent on the VendorShell resource XmNlayoutDirection. + + +XmARROWS_FLAT_BEGINNING + +Places a pair of arrows side by side before the XmSpinBox +children. Positioning for this layout is dependent on the VendorShell resource XmNlayoutDirection. + + +XmARROWS_FLAT_END + +Places a pair of arrows side by side after the XmSpinBox +children. Positioning for this layout is dependent on the VendorShell resource XmNlayoutDirection. + + +XmARROWS_SPLIT + +Places a left arrow on the left side and a right arrow on the right +side of the child(ren). + + + + + +XmNarrowSize + +Specifies both the width and height of the arrow in pixels. + + +XmNdefaultArrowSensitivity + +Specifies the default sensitivity of the arrows in the widget. Insensitive +arrows change color, cannot be depressed, and perform no action. (This resource +may be overridden by the constraint resource XmNarrowSensitivity for individual traversable text children +of the SpinBox.) Possible default sensitivity values are as follows: + +XmARROWS_SENSITIVE + +Both arrows are sensitive. + + +XmARROWS_DECREMENT_SENSITIVE + +Only the decrement arrow (as determined by XmNlayoutDirection) is sensitive. The increment arrow is insensitive. + + + +XmARROWS_INCREMENT_SENSITIVE + +Only the increment arrow (as determined by XmNlayoutDirection) is sensitive. The decrement arrow is insensitive. + + + +XmARROWS_INSENSITIVE + +Both arrows are insensitive. + + + + + +XmNdetailShadowThickness + +Specifies the thickness of the inside arrow shadows. The default thickness +is 2 pixels. + + +XmNinitialDelay + +Specifies how long, in milliseconds, the mouse button must be held +down before automatic spinning begins. In other words, when the user selects +the increment or decrement arrow and keeps it depressed, this delay occurs +before the choices start spinning. If XmNinitialDelay is 0, then XmNrepeatDelay +is used as the initial delay. + + +XmNmarginHeight + +Specifies the amount of blank space between the top edge of the SpinBox +widget and the first item in each column, and the bottom edge of the SpinBox +widget and the last item in each column. + + +XmNmarginWidth + +Specifies the amount of blank space between the left edge of the SpinBox +widget and the first item in each row, and the right edge of the SpinBox widget +and the last item in each row. + + +XmNmodifyVerifyCallback + +This callback is called before the SpinBox position changes (see the +Constraint resource XmNposition). +The application can use this callback to set the next position, change SpinBox +resources, or cancel the impending action. For example, this callback can +be used to stop the spinning just before wrapping at the upper and lower +position boundaries. If the doit member +is set to False, nothing happens. Otherwise the position changes. Reasons +sent by the callback are XmCR_SPIN_NEXT, +XmCR_SPIN_PRIOR, XmCR_SPIN_FIRST, or XmCR_SPIN_LAST. + + +XmNrepeatDelay + +When the user selects and keeps an arrow button depressed by pressing +and holding Btn1, spinning begins. After the time specified +in XmNinitialDelay elapses, the +SpinBox position changes automatically until the arrow button is released. +The XmNrepeatDelay resource specifies +the delay in milliseconds between each automatic change. If XmNrepeatDelay is set to 0 (zero), automatic +spinning is turned off and XmNinitialDelay +is ignored. + + +XmNspacing + +Specifies the horizontal and vertical spacing between items contained +within the SpinBox widget. + + +XmNvalueChangedCallback + +This is called n+1 times for +n SpinBox position changes (see the Constraint resource +XmNposition). Reasons sent by the +callback are XmCR_OK, XmCR_SPIN_NEXT, XmCR_SPIN_PRIOR, XmCR_SPIN_FIRST, or XmCR_SPIN_LAST. +Other members are detailed in the callback structure description. + + + + + + + + + + + + + +XmSpinBox Constraint +Resource Set + +Name +Class +Type +Default +Access + +XmNarrowSensitivity +XmCArrowSensitivity +unsigned char +XmARROWS_DEFAULT_SENSITIVITY +CSG + +XmNdecimalPoints +XmCDecimalPoints +short +0 +CSG + +XmNincrementValue +XmCIncrementValue +int +1 +CSG + +XmNmaximumValue +XmCMaximumValue +int +10 +CSG + +XmNminimumValue +XmCMinimumValue +int +0 +CSG + +XmNnumValues +XmCNumValues +int +0 +CSG + +XmNposition +XmCPosition +int +0 +CSG + +XmNpositionType +XmCPositionType +char +XmPOSITION_VALUE +CG + +XmNspinBoxChildType +XmSpinBoxChildType +unsigned char +XmSTRING +CG + +XmNvalues +XmCValues +XmStringTable +NULL +CSG + +XmNarrowSensitivity + +Specifies the sensitivity of the arrows for a SpinBox child. By using +this resource in the definition of a SpinBox child, the application programmer +can override the default SpinBox sensitivity (set by XmNdefaultArrowSensitivity) for a particular child. This allows +each traversable child to have a different arrow sensitivity. The arrow +sensitivity values are as follows: + +XmARROWS_SENSITIVE + +Both arrows are sensitive. + + +XmARROWS_DECREMENT_SENSITIVE + +Only the decrement arrow (as determined by XmNlayoutDirection) is sensitive. + + +XmARROWS_INCREMENT_SENSITIVE + +Only the increment arrow (as determined by XmNlayoutDirection) is sensitive. + + +XmARROWS_INSENSITIVE + +Both arrows are insensitive. + + +XmARROWS_DEFAULT_SENSITIVITY + +Use the sensitivity specified in the XmNdefaultArrowSensitivity resource. + + + + + +XmNdecimalPoints + +Specifies the number of decimal places used when displaying the value +of a SpinBox numeric type child. If the number of decimal places specified +is greater than the number of digits in a displayed value, the value is padded +with 0 (zeros). For example, when XmNinitialValue is 1 +and XmNmaximumValue is 1000 and XmNdecimalPoints is 3, the range of values displayed +in the SpinBox is 0.001 to 1.000. This is used only when XmNspinBoxChildType is XmNUMERIC. + + +XmNincrementValue + +Specifies the amount by which to increment or decrement a SpinBox numeric +type child. This is used only when XmNspinBoxChildType is XmNUMERIC. + + +XmNmaximumValue + +Specifies the highest possible value for a numeric SpinBox. This is +used only when XmNspinBoxChildType +is XmNUMERIC. + + +XmNminimumValue + +Specifies the lowest possible value for a numeric SpinBox. This is +used only when XmNspinBoxChildType +is XmNUMERIC. + + +XmNnumValues + +Specifies the number of strings in XmNvalues. The application must change this value when strings are added +or removed from XmNvalues. This +is used only when XmNspinBoxChildType +is XmSTRING. + + +XmNposition + +Specifies the position of the currently displayed item. The interpritation +of XmNposition is dependent upon the value of the XmNpositionType resource. +When XmNpositionType is XmPOSITION_INDEX the XmNposition value is interpreted as follows: +For XmSpinBox children of type XmNUMERIC, +the XmNposition resource is interpreted as an index into +an array of items. The minimum allowable value for XmNposition is 0. The maximum allowable value for XmNposition +is (XmNmaximumValue-XmNminimumValue)/XmNincrementValue. +The value display by the XmSpinBox child is XmNminimumValue+(XmNposition*XmNincrementValue). For XmSpinBox children of type XmSTRING, the XmNposition resource is interpreted as an index into an array of XmNnumValues items. The minimum allowable value for XmNposition is 0. The maximum allowable value for XmNposition +is XmNnumValues - 1. The value displayed by the XmSpinBox is the XmNposition'th value in the XmNvalues array. +When XmNpositionType is XmPOSITION_VALUE the XmNposition value is interpreted as follows: + +For XmSpinBox children of type XmNUMERIC, the XmNposition resource is interpreted as +the actual value to be displayed. The minimum allowable value for XmNposition is XmNminimumValue. The maximum allowable +value for XmNposition is XmNmaximumValue. +The value displayed by the XmSpinBox child is XmNposition. For XmSpinBox children of type XmSTRING, the interpretation is the same for XmPOSITION_VALUE as for XmPOSITION_INDEX. +Position values falling outside the specified range are invalid. When +an application assigns a value to XmNposition which is +less than the minimum, XmNposition is set to the minimum +and an error message is displayed. When an application assigns a value +to XmNposition which is greater than the maximum, XmNposition is set to the maximum and an error message is displayed. + + + +XmNpositionType + +Specifies how values the XmNposition resource are +to be interpreted. Valid values include XmPOSITION_INDEX +and XmPOSITION_VALUE. + + +XmNspinBoxChildType + +Specifies the type of data displayed in the child: + +XmNUMERIC + +The SpinBox choice range is defined by numeric minimum, maximum, and +incremental values. + + +XmSTRING + +The SpinBox choices are alphanumeric. + + + + + +XmNvalues + +Specifies the array of XmStrings +to be displayed in a SpinBox string type child. The application must change XmNnumValues when strings are added to or removed +from XmNvalues. This is used only +when XmNspinBoxChildType is XmSTRING. + + + + + +Inherited Resources +SpinBox inherits behavior and resources from the superclasses described +in the following tables. For a complete description of each resource, refer +to the reference page for that superclass. + + + + + + + + + + +XmManager Resource +Set + +Name +Class +Type +Default +Access + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + +XmNinitialFocus +XmCInitialFocus +Widget +dynamic +CSG + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + +XmNshadowThickness +XmCShadowThickness +Dimension +0 +CSG + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CG + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + +Composite Resource +Set + +Name +Class +Type +Default +Access + +XmNchildren +XmCReadOnly +WidgetList +NULL +G + +XmNinsertPosition +XmCInsertPosition +XtOrderProc +NULL +CSG + +XmNnumChildren +XmCReadOnly +Cardinal +0 +G + + + + + + + + + + +Core Resource Set + +Name +Class +Type +Default +Access + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + +XmNdepth +XmCDepth +int +dynamic +CG + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + +XmNheight +XmCHeight +Dimension +dynamic +CSG + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + +XmNscreen +XmCScreen +Screen * +dynamic +CG + +XmNsensitive +XmCSensitive +Boolean +True +CSG + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + +XmNx +XmCPosition +Position +0 +CSG + +XmNy +XmCPosition +Position +0 +CSG + + +Callback +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + Widget widget; + Boolean doit; + int position; + XmString value; + Boolean crossed_boundary; +} XmSpinBoxCallbackStruct; + +reason + +Indicates why the callback was invoked. Reasons may be the following: + + +XmCR_OK + +Spinning has stopped because the SpinBox arrow has been disarmed. XmCR_OK is either the last or only call. + + +XmCR_SPIN_NEXT + +The increment arrow has been armed and position is increasing. Further +callbacks will come. For a numeric type child, the values displayed are +approaching the maximum. For a string SpinBox, the values displayed are +approaching the last entry in the array of XmString s. + + +XmCR_SPIN_PRIOR + +The decrement arrow has been armed and position is decreasing. Further +callbacks will come. For a numeric type child, the values displayed are +approaching the minimum. For a string type child, the values displayed +are approaching the first entry in the array of XmStrings. + + +XmCR_SPIN_FIRST + +The begin data (osfBeginData) key sequence has been +pressed. The SpinBox is at its first position, displaying the lowest value +or the first entry in the array of XmStrings. + + + +XmCR_SPIN_LAST + +The end data (osfEndData) key sequence has been pressed. +The SpinBox is at its last position, displaying the highest value or the +last entry in the array of XmStrings. + + + + + + +event + +Points to the XEvent that triggered this callback. + + + +widget + +Specifies the child widget affected by this callback. + + +doit + +When the callback is XmNmodifyVerifyCallback, doit indicates whether or +not an action will be performed before the SpinBox position changes. If +the callback leaves doit set to True (the +default), the spinning action is performed. If the callback sets +doit to False, the spinning action is not performed. +When the callback is XmNvalueChangedCallback, doit is ignored. + + +position + +Specifies the next value of the SpinBox position (same as XmNposition). This is an output field for +the XmNmodifyVerifyCallback, which +may change the next position as dictated by the needs of an application. + + + +value + +Specifies the new XmString value +in the text child widget. The user program must copy this string if it +is to be used outside the callback routine. + + +crossed_boundary + +Specifies whether or not the SpinBox has crossed the upper or lower +boundary (the last or first compound string, or the maximum or minimum value). +The crossed_boundary value is True if the +SpinBox has just crossed a boundary, and False if it has not. + + + + + +Translations +The XmSpinBox translations are as follows: + +The following key names are listed in the X standard key event translation +table syntax. This format is the one used by Motif to specify the widget actions +corresponding to a given key. A brief overview of the format is provided under &cdeman.VirtualBindings;. For a complete description +of the format, please refer to the X Toolkit Instrinsics Documentation. + +Btn1Down: + +SpinBArm() + + +Btn1Up: + +SpinBDisarm() + + +:KeyosfUp : + +SpinBPrior() + + +:KeyosfDown : + +SpinBNext() + + +:KeyosfLeft : + +SpinBLeft() + + +:KeyosfRight : + +SpinBRight() + + +:KeyosfBeginData : + +SpinBFirst() + + +:KeyosfEndData : + +SpinBLast() + + + + + +Accelerators +The XmNaccelerators resource +of a SpinBox are added to each traversable text child. The default XmNaccelerators are defined in the following +list. The bindings for KeyosfUp and KeyosfDown cannot be changed. + +Key osfUp: + +SpinBPrior() + + +Key osfDown: + +SpinBNext() + + +KeyUp osfUp: + +SpinBDisarm() + + +KeyUp osfDown: + +SpinBDisarm() + + +Key osfLeft: + +SpinBLeft() + + +Key osfRight: + +SpinBRight() + + +KeyUp osfLeft: + +SpinBDisarm() + + +KeyUp osfRight: + +SpinBDisarm() + + +Key osfBeginData: + +SpinBFirst() + + +Key osfEndData: + +SpinBLast() + + + + + +Action Routines +The XmSpinBox action routines are as follows: + + +SpinBArm(): + +Visually arms the SpinBox by drawing the armed arrow so that it appears +to be depressed. This action is initiated when the user presses Btn1 while the pointer is within the boundaries of either the increment +or decrement arrow. The arrow remains visually armed as long as Btn1 remains depressed. +If the time period specified by XmNrepeatDelay is not greater than zero milliseconds, nothing else happens +while Btn1 remains depressed. +If the time period specified by XmNrepeatDelay is greater than zero milliseconds, and the arrow is disarmed +before the time period specified by XmNinitialDelay has elapsed, nothing else happens in this action. +If the time period specified by XmNrepeatDelay is greater than zero milliseconds, and the arrow is still +armed after the time period specified by XmNinitialDelay has elapsed, the following occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_NEXT +if the increment arrow is armed, or to XmCR_SPIN_PRIOR if the decrement arrow is armed. + +The position member is set +to the next position. + +The doit member is set to +True. + +XmNmodifyVerifyCallback, +if it exists, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, +nothing else happens until the XmNrepeatDelay period has elapsed, or until Btn1 is released. + + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_NEXT if the increment arrow is armed, or XmCR_SPIN_PRIOR if the decrement arrow is armed. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. SpinBox ignores any changes to position or doit members made by XmNvalueChangedCallback. + + +These events are repeated each time the XmNrepeatDelay period elapses and the arrow remains armed. + + + +SpinBDisarm(): + +Visually disarms the SpinBox by drawing the previously armed arrow +so that it no longer appears to be depressed. +If the time period specified by XmNrepeatDelay is not greater than zero milliseconds, or the time period specified +by XmNinitialDelay has not elapsed, +the following then occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_NEXT +if the increment arrow is armed, or to XmCR_SPIN_PRIOR if the decrement arrow is armed. + +The position member is set +to the next position. + +The doit member is set to +True. + +The XmNmodifyVerifyCallback, +if there is one, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, nothing +else happens until the XmNrepeatDelay +period has elapsed, or until Btn1 is released. + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_NEXT if the increment arrow is armed, or XmCR_SPIN_PRIOR if the decrement arrow is armed. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. SpinBox ignores any changes to position or doit members made by +an XmNvalueChangedCallback. + + +If an XmNvalueChangedCallback +procedure is issued after the button has been armed, regardless of the value +of XmNrepeatDelay or whether the XmNinitialDelay has expired: + +The reason member of the +SpinBox callback structure is set to XmCR_OK. + +The position member is set +to the current value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. + + + + +SpinBFirst(): + +The following occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_FIRST. + + +The position member is set +to the first (0) position. + +The doit member is set to +True. + +XmNmodifyVerifyCallback, +if it exists, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, nothing +else happens until the XmNrepeatDelay +period has elapsed, or until Btn1 is released. + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_FIRST. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. + +The reason member of the +SpinBox callback structure is set to XmCR_OK. + +The position member is set +to the current (new) XmNposition +value. + +The XmNvalueChangedCallback +is called again. SpinBox ignores any changes to position or doit members made by XmNvalueChangedCallback. + + + + +SpinBLast(): + +The following occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_LAST. + + +The position member is set +to the last position. + +The doit member is set to +True. + +XmNmodifyVerifyCallback, +if it exists, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, nothing +else happens until the XmNrepeatDelay +period has elapsed, or until Btn1 is released. + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_LAST. + +The position member is set +to the current (new) value XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. + +The reason member of the +SpinBox callback structure is set to XmCR_OK. + +The position member is set +to the current (new) of XmNposition. + + +XmNvalueChangedCallback +is called again. SpinBox ignores any changes to the position or doit members made by +XmNvalueChangedCallback. + + + + +SpinBLeft(): + +If the VendorShell resource XmNlayoutDirection is left-to-right, the SpinBPrior action is +invoked. Otherwise, the SpinBNext action is invoked. + + + +SpinBNext(): + +Visually arms the SpinBox by drawing the increment arrow so that it +appears to be depressed. The following occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_NEXT. + + +The position member is set +to the next position. + +The doit member is set to +True. + +XmNmodifyVerifyCallback, +if it exists, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, nothing +else happens until the XmNrepeatDelay +period has elapsed, or until Btn1 is released. + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_NEXT. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. + +The reason member of the +SpinBox callback structure is set to XmCR_OK. + +The position member is set +to the current (new) XmNposition. + + +The XmNvalueChangedCallback +is called again. SpinBox ignores any changes to position or doit members made by XmNvalueChangedCallback. + + + + +SpinBPrior(): + +Visually arms the SpinBox by drawing the decrement arrow so that it +appears to be depressed. The following occurs: + +The reason member of the +SpinBox callback structure, XmSpinBoxCallbackStruct, is set to XmCR_SPIN_PRIOR. + + +The position member is set +to the next position. + +The doit member is set to +True. + +XmNmodifyVerifyCallback, +if it exists, is invoked. The application may change the value of +position and doit. +If the application sets doit to False, nothing +else happens until the XmNrepeatDelay +period has elapsed, or until Btn1 is released. + + +If doit remains set to True, the following +occurs: + +The value of XmNposition +is changed to the value of position in the +SpinBox callback structure. + +The text corresponding to the new position is displayed in +the traversable text child that currently has focus. + +The reason member of the +SpinBox callback structure is set to XmCR_SPIN_PRIOR. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback, +if it exists, is called. + +The reason member of the +SpinBox callback structure is set to XmCR_OK. + +The position member is set +to the current (new) value of XmNposition. + + +XmNvalueChangedCallback +is called again. SpinBox ignores any changes to position or doit members +made by XmNvalueChangedCallback. + + + + + +SpinBRight(): + +If the VendorShell resource XmNlayoutDirection is left-to-right, the SpinBNext action is +invoked. Otherwise, the SpinBPrior action is invoked. + + + + + + +RELATED +&cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, +&cdeman.XmCreateSpinBox;, +&cdeman.XmManager;, and +&cdeman.XmString;. + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxD.sgm new file mode 100644 index 00000000..e961c2de --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxD.sgm @@ -0,0 +1,58 @@ + + + + + + + + + + +XmSimpleSpinBoxDeletePos +library call + + +XmSimpleSpinBoxDeletePos +delete a XmSimpleSpinBox item + + + + +#include <Xm/SpinB.h> + +void XmSimpleSpinBoxDeletePos +Widget w +int pos + + + +DESCRIPTION +The +XmSimpleSpinBoxDeletePos function deletes a specified item from a XmSimpleSpinBox widget. + +The +w argument specifies the widget ID. + +The +pos argument specifies the position of the item to be deleted. +A value of 1 means the first item in the list; zero means the last item. + + + +RETURN VALUE +The +XmSimpleSpinBoxDeletePos function returns no value. + + + +SEE ALSO +&cdeman.XmSimpleSpinBox;, +]]> +XmSimpleSpinBox, +]]> +&cdeman.XmSimpleSpinBoxAddItem;, &cdeman.XmSimpleSpinBoxSetItem;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxS.sgm new file mode 100644 index 00000000..0421029f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxS.sgm @@ -0,0 +1,64 @@ + + + + + + + + + + +XmSimpleSpinBoxSetItem +library call + + +XmSimpleSpinBoxSetItem +set an item in the XmSimpleSpinBox list + + + + +#include <Xm/SpinB.h> + +void XmSimpleSpinBoxSetItem +Widget w +XmString item + + + +DESCRIPTION +The +XmSimpleSpinBoxSetItem function selects an item in the list of the given XmSimpleSpinBox +widget and makes it the current value. + +The +w argument specifies the widget ID. + +The +item argument specifies the +XmString for the item to be set in the XmSimpleSpinBox. +If the +item is not found on the list, +XmSimpleSpinBoxSetItem notifies the user via the +XtWarning function. + + + +RETURN VALUE +The +XmSimpleSpinBoxSetItem function returns no value. + + + +SEE ALSO +&cdeman.XmSimpleSpinBox;, +]]> +XmSimpleSpinBox, +]]> +&cdeman.XmSimpleSpinBoxAddItem;, &cdeman.XmSimpleSpinBoxDeletePos;; XtWarning(3). ]]>XtWarning ]]>in the &str-Zt;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxV.sgm new file mode 100644 index 00000000..7aae5895 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/SpinBoxV.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + +XmSpinBoxValidatePosition +library call + + +XmSpinBoxValidatePosition + +translate the current value of the specified XmSpinBox child +into a valid position + + + + +#include <Xm/SpinBox.h> + +int XmSpinBoxValidatePosition +Widget textfield +int *position + + + +DESCRIPTION +The +XmSpinBoxValidatePosition function +is a utility that can be used by applications wanting to +implement a policy for tracking user modifications to editable +XmSpinBox children of type +XmNUMERIC. The specifics of when and how the user's +modifications take effect is left up to the application. + + +text_field + +The text_field argument specifies the +widget ID of the child of the XmSpinBox that is +being modified. The requirement on text_field +is that it holds the +accessTextual trait (already a requirement for +children of XmSpinBox). This way, +XmSpinBox can extract the string out of the +text_field widget (even if it is not an +XmTextField). + + + +position + +The location pointed to by the position argument is assigned the result +of the translation done by XmSpinBoxValidatePosition. +XmSpinBoxValidatePosition first checks to make sure this is an +XmNUMERIC XmSpinBox child. If it is not, +XSmpinBoxValidatePosition sets position to the current +position and returns XmCURRENT_VALUE. + + + + +XmSpinBoxValidatePosition +attempts to translate the input string to a floating point number. If +this translation fails, +XmSpinBoxValidatePosition sets position to the current position and +returns XmCURRENT_VALUE. + +XmSpinBoxValidatePosition converts the floating point number to an integer using the +XmNdecimalPoints resource. Extra decimal places are truncated. The resulting integer is range +checked to make sure it falls within the valid range defined by XmNminimumValue and +XmNmaximumValue inclusive. If the input falls outside this range, +XmSpinBoxValidatePosition sets position to the nearest limit and returns either +XmMINIMUM_VALUE or XmMAXIMUM_VALUE. + +Finally, XmSpinBoxValidatePosition checks the integer to make sure it belongs to the series +defined by XmNminimumValue ... XmNminumumValue + ((n - 1) * XmNincrementlValue). If +the integer does not belong to this series, XmSpinBoxValidatePosition sets position to the +nearest element which is less than or equal to the integer and returns +XmINCREMENT_VALUE. + +Otherwise, XmSpinBoxValidatePosition assigns the integer to position and returns +XmVALID_VALUE. + + + +RETURN VALUE +The +XmSpinBoxValidatePosition function returns the status of the validation. +The set of possible values returned is as follows: + + +XmCURRENT_VALUE + +Cannot convert, returning current position_value. + + + +XmMINIMUM_VALUE + +Less than min. + + + +XmMAXIMUM_VALUE + +More than max. + + + +XmINCREMENT_VALUE + +Not on increment. + + + +XmVALID_VALUE + +Okay. + + + + + + +EXAMPLES +This first example demonstrates how the XmSpinBoxValidatePosition +function could be used from inside an +XmNmodifyVerifyCallback callback installed on the +XmSpinBox or the +XmSimpleSpinBox: + +/* + * Install a callback on a spin box arrow press. + */ + XtAddCallback(sb, XmNmodifyVerifyCallback, ModifyVerifyCB, NULL); + XtAddCallback(simple_sb, XmNmodifyVerifyCallback, ModifyVerifyCB, NULL); + +with the callback doing: + + +void ModifyVerifyCB(widget, call_data, client_data) { + XmSpinBoxCallbackStruct *cbs = (XmSpinBoxCallbackStruct*) call_data; + int position; + Widget textual = NULL; + if (XtIsSubclass(w, xmSimpleSpinBoxWidgetClass)) + { + Arg args[1]; + XtSetArg(args[0], XmNtextField, &textual); + XtGetValues(w, args, 1); + } + else if (XtIsSubclass(w, xmSpinBoxWidgetClass)) + textual = cbs->widget; + else + textual = (Widget) NULL; + + ... + + if (XmSpinBoxValidatePosition(textual, &position) == XmCURRENT_VALUE) + XBell(XtDisplay(w), 0); + else + cbs->position = position; +} + +This second example demonstrates how the XmSpinBoxValidatePosition +function could be used from inside an +XmNactivateCallback callback installed on +the TextField child of the XmSpinBox: + +/* + * Install a callback on a spin box arrow press. + */ +XtAddCallback(tf, XmNactivateCallback, ModifyVerifyChildCB, NULL); + +with the callback doing: + +void ModifyVerifyChildCB(widget, call_data, client_data) { + int position; + Widget textual = widget; + Arg args[1]; + + if (XmSpinBoxValidatePosition (textual, &position) == XmCURRENT_VALUE) + XBell(XtDisplay(widget), 0); + + /* Set the position constraint resource of the textfield */ + + XtSetArg(args[0], XmNposition, position); + XtSetValues(textual, args, 1); +} + + + +SEE ALSO +&cdeman.XmSpinBox;, +&cdeman.XmCreateSpinBox; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrBas.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrBas.sgm new file mode 100644 index 00000000..8f169e4f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrBas.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmStringBaseline +library call + + +XmStringBaseline +A compound string function that returns the number of pixels between the top of the character box and the baseline of the first line of text + +XmStringBaseline + +compound string functions +XmStringBaseline + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Dimension XmStringBaseline + +XmRenderTable rendertable +XmString string + + + +DESCRIPTION +XmStringBaseline +returns the number of pixels between the top of the character +box and the baseline of the first line of text in the provided compound +string. + + + +rendertable + +Specifies the render table + + + + +string + +Specifies the string + + + + + + +RETURN +Returns the number of +pixels between the top of the character box and the baseline of the first +line of text. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByA.sgm new file mode 100644 index 00000000..85db4d31 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByA.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmStringByteCompare +library call + + +XmStringByteCompare +A compound string function that indicates the results of a byte-by-byte comparison + +XmStringByteCompare + +compound string functions +XmStringByteCompare + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringByteCompare + +XmString s1 +XmString s2 + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. +XmStringByteCompare +returns a Boolean indicating the results of a byte-by-byte +comparison of two compound strings. + +In general, if two compound strings are created with the same (char *) +string using XmStringCreateLocalized in the same language +environment, the compound strings compare as equal. +If two compound strings are created with the same (char *) string and +the same font list element tag set other than XmFONTLIST_DEFAULT_TAG +using XmStringCreate, the strings compare as +equal. + +In some cases, once a compound string +is put into a widget, that string is converted into an internal form to +allow faster processing. Part of the conversion process strips out +unnecessary or redundant information. If an application then does an +XtGetValues to retrieve a compound string from a widget (specifically, +Label and all of its subclasses), it is not guaranteed that the compound +string returned is byte-for-byte the same as the string given to +the widget originally. + + + +s1 + +Specifies a compound string to be compared with s2 + + + + +s2 + +Specifies a compound string to be compared with s1 + + + + + + +RETURN +Returns True if two compound strings are identical byte-by-byte. + + + +RELATED +&cdeman.XmStringCreate; and +&cdeman.XmStringCreateLocalized;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByB.sgm new file mode 100644 index 00000000..9a74ad75 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrByB.sgm @@ -0,0 +1,62 @@ + + + + + + + + + + + +XmStringByteStreamLength +library call + + +XmStringByteStreamLength +A function that returns the size of a string + +XmStringByteStreamLength + + + + + + + + + + + +#include <Xm/Xm.h> +unsigned int XmStringByteStreamLength (string) + unsigned char *string; + + + + + + +DESCRIPTION +XmStringByteStreamLength receives a byte stream format string +and returns the size, in bytes, of that stream, including the header. +Because of this header information, even a NULL string +will cause XmStringByteStreamLength to return a non-zero value. + + + +string + +Specifies the byte stream format string. + + + + + + +RETURN VALUES +Returns the size of string, including the header. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoA.sgm new file mode 100644 index 00000000..6c358f8b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoA.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + +XmStringCompare +library call + + +XmStringCompare +A compound string function that compares two strings + +XmStringCompare + +compound string functions +XmStringCompare + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringCompare + +XmString s1 +XmString s2 + + + +DESCRIPTION +XmStringCompare returns a Boolean value indicating the results of a +semantically equivalent comparison of two compound strings. + +Semantically equivalent means that the strings have the +same text components, font list element tags, directions, +and separators. In general, if two compound strings are created +with the same (char *) string using XmStringCreateLocalized in +the same language environment, the compound strings compare as equal. +If two compound strings are created with the same text and tag argument +using XmStringCreate, the strings compare as equal. + + + +s1 + +Specifies a compound string to be compared with s2 + + + + +s2 + +Specifies a compound string to be compared with s1 + + + + + + +RETURN +Returns True if two compound strings are equivalent. + + + +RELATED +&cdeman.XmStringCreate; and +&cdeman.XmStringCreateLocalized;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoB.sgm new file mode 100644 index 00000000..346685fb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoB.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmStringComponentCreate +library call + + +XmStringComponentCreate +A compound string function that creates arbitrary components + +XmStringComponentCreate + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringComponentCreate + +XmStringComponentType c_type +unsigned int length +XtPointer value + + + +DESCRIPTION +XmStringComponentCreate creates a new XmString component +of type c_type, containing value. If value is invalid +for the particular component type, this function fails and +returns NULL. + + + +c_type + +Specifies the type of component to be created. + + + + +length + +Specifies the length in bytes of value. +Note that this must be precisely the length of the value +string, not including any trailing null characters. + + + + +value + +Specifies the value to be used in the creation of the component. + + + + +Refer to the &cdeman.XmStringComponentType; reference page for a list of +the possible XmString component types. + + + +RETURN +If value is invalid for c_type, fails +and returns NULL. Otherwise, this function returns a new compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +RELATED +&cdeman.XmString;, +XmStringGetNextTriple, XmStringComponentType, and +&cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoC.sgm new file mode 100644 index 00000000..b6ec5e6c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoC.sgm @@ -0,0 +1,228 @@ + + + + + + + + + + + +XmStringComponentType +library call + + +XmStringComponentType +Data type for compound string components + +XmStringComponentType + +data types +XmStringComponentType + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmStringComponentType is the data type specifying compound string +component types. A compound string component identifies some +part of a compound string, and can have a value and length. A compound +string component can be one of the +following types. These component types are grouped +according to their length and value types. + +The following components have values of NULL and lengths of 0 (zero). + + + +XmSTRING_COMPONENT_SEPARATOR + +This component usually maps to a newline or carriage return in +displayed text. + + + + +XmSTRING_COMPONENT_TAB + +This component may be thought of as a text component containing only a +single tab. + + + + +XmSTRING_COMPONENT_LAYOUT_POP + +The layout direction is kept on a stack, with the current direction +kept on top of the stack. When this component is read, the most +recently read layout direction is popped off the stack and replaced by +the direction immediately before it. + + + + +XmSTRING_COMPONENT_END + +This component marks the end of a compound string. No other components +should follow. If an application does not place an +XmSTRING_COMPONENT_END component at the end of +an XmString, Motif automatically does it for the application. + + + + +The following component has a value of XmDirection and the +length of that direction. + + + +XmSTRING_COMPONENT_LAYOUT_PUSH + +The layout direction is kept on a stack, with the current direction +kept on top of the stack. This component replaces the current layout +direction, and causes another to be pushed onto the top of this stack. + + + + +The following component has a value of XmStringDirection and the +length of that direction. + + + +XmSTRING_COMPONENT_DIRECTION + +This component sets the string direction by overriding the previous +string direction. + + + + +The following components have values of type char * or some +equivalent type, and the lengths of these types. + + + +XmSTRING_COMPONENT_LOCALE_TEXT + +This component contains the multibyte text of a compound string. + + + + +XmSTRING_COMPONENT_WIDECHAR_TEXT + +This component contains the widechar text of a compound string. + + + + +XmSTRING_COMPONENT_TEXT + +This component contains the charset text of a compound string. Note +that a compound string cannot contain both charset and locale +(multibyte or widechar) text. + + + + +XmSTRING_COMPONENT_RENDITION_BEGIN + +This component marks the beginning of a new rendition. All text +following this component will be rendered using this rendition as the +primary one. If there is already a rendition in effect, it is kept in +memory and used to fill in any unspecified values in the primary +rendition. Renditions are kept until a corresponding +XmSTRING_COMPONENT_RENDITION_END component is encountered. + + + + +XmSTRING_COMPONENT_RENDITION_END + +This component signifies that the specified rendition will no longer +be used to render text, and will not be available to fill in +unspecified values of newer renditions. + + + + +XmSTRING_COMPONENT_UNKNOWN + +This component type signifies that the component contents belong to an +unknown component type. + + + + +XmSTRING_COMPONENT_LOCALE + +Use this component to specify the locale in which an internationalized +application is to execute. +The only valid character string for this component +is _MOTIF_DEFAULT_LOCALE. + + + + +XmSTRING_COMPONENT_TAG + +For charset text, this is the tag of the font to be used to display +the text. This tag is sometimes referred to as the charset tag or the +fontlist tag. + + + + +XmSTRING_COMPONENT_CHARSET + +This component is obsolete and remains for compatibility with previous +releases. It has been replaced by XmSTRING_COMPONENT_TAG. + + + + +XmSTRING_COMPONENT_FONTLIST_ELEMENT_TAG + +This component is obsolete and remains for compatibility with previous +releases. It has been replaced by XmSTRING_COMPONENT_TAG. + + + + +Some compound string components depend on values defined in other +components. The XmSTRING_COMPONENT_TAB component definition, for +example, depends on information in the +XmSTRING_COMPONENT_RENDITION_BEGIN. To account for these +dependencies, a typical compound string will have its member +components in the following order: + +[ + [ XmSTRING_COMPONENT_LAYOUT_PUSH ] + [ XmSTRING_COMPONENT_RENDITION_BEGIN ]* + [ XmSTRING_COMPONENT_TAG | XmSTRING_COMPONENT_LOCALE ] + [ XmSTRING_COMPONENT_TAB ]* + [ XmSTRING_COMPONENT_DIRECTION ] + [ XmSTRING_COMPONENT_TEXT | + XmSTRING_COMPONENT_LOCALE_TEXT | + XmSTRING_COMPONENT_WIDECHAR_TEXT ] + [ XmSTRING_COMPONENT_RENDITION_END ]* + [ XmSTRING_COMPONENT_LAYOUT_POP ] + [ XmSTRING_COMPONENT_SEPARATOR ] +]* +XmSTRING_COMPONENT_END + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoD.sgm new file mode 100644 index 00000000..48295dfc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoD.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmStringConcat +library call + + +XmStringConcat +A compound string function that appends one string to another + +XmStringConcat + +compound string functions +XmStringConcat + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringConcat + +XmString s1 +XmString s2 + + + +DESCRIPTION +XmStringConcat copies s2 to the end of s1 and returns +a copy of the resulting compound string. The original strings are preserved. +The function will allocate space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +s1 + +Specifies the compound string to which a copy of s2 is appended + + + + +s2 + +Specifies the compound string that is appended to the end of s1 + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoE.sgm new file mode 100644 index 00000000..bc3224b1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCoE.sgm @@ -0,0 +1,98 @@ + + + + + + + + + + + +XmStringConcatAndFree +library call + + +XmStringConcatAndFree +A compound string function that appends one string to another and frees the original strings + +XmStringConcatAndFree + +compound string functions +XmStringConcatAndFree + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringConcatAndFree + +XmString s1 +XmString s2 + + + +DESCRIPTION +XmStringConcatAndFree copies s2 to the end of s1 and returns +a copy of the resulting compound string. The original strings are freed. +The function will allocate space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +s1 + +Specifies the compound string to which a copy of s2 is appended + + + + +s2 + +Specifies the compound string that is appended to the end of s1 + + + + +The XmStringConcatAndFree function works like the +XmStringConcat function, except that it frees the s1 and +s2 strings, and is therefore more efficient. You should use +XmStringConcatAndFree instead of XmStringConcat if you +want s1 and s2 to be freed afterwards. + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringConcat;, +&cdeman.XmStringCreate;, and +&cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCop.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCop.sgm new file mode 100644 index 00000000..a09226a6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCop.sgm @@ -0,0 +1,81 @@ + + + + + + + + + + + +XmStringCopy +library call + + +XmStringCopy +A compound string function that makes a copy of a string + +XmStringCopy + +compound string functions +XmStringCopy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringCopy + +XmString s1 + + + +DESCRIPTION +XmStringCopy makes a copy of an existing compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +s1 + +Specifies the compound string to be copied + + + + + + +RETURN +Returns a compound string. + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrA.sgm new file mode 100644 index 00000000..8fddc6ed --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrA.sgm @@ -0,0 +1,142 @@ + + + + + + + + + + + +XmStringCreate +library call + + +XmStringCreate +A compound string function that creates a compound string + +XmStringCreate + +compound string functions +XmStringCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringCreate + +char *text +char *tag + + + +DESCRIPTION +XmStringCreate creates a compound +string with two components: text and a font list element tag. +The function will allocate space to hold the returned compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +text + +Specifies a NULL-terminated string to be used as the text component of +the compound string. + + + + +tag + +Specifies the tag component to be associated with the given +text. The value XmFONTLIST_DEFAULT_TAG identifies a locale +text segment. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmFontList;, +&cdeman.XmFontListAdd;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmFontListCopy;, +&cdeman.XmFontListCreate;, +&cdeman.XmFontListEntryCreate;, +&cdeman.XmFontListEntryFree;, +&cdeman.XmFontListEntryGetFont;, +&cdeman.XmFontListEntryGetTag;, +&cdeman.XmFontListEntryLoad;, +&cdeman.XmFontListFree;, +&cdeman.XmFontListFreeFontContext;, +&cdeman.XmFontListGetNextFont;, +&cdeman.XmFontListInitFontContext;, +&cdeman.XmFontListNextEntry;, +&cdeman.XmFontListRemoveEntry;, +&cdeman.XmString;, +&cdeman.XmStringBaseline;, +&cdeman.XmStringByteCompare;, +&cdeman.XmStringCompare;, +&cdeman.XmStringConcat;, +&cdeman.XmStringCopy;, +&cdeman.XmStringCreateLocalized;, +&cdeman.XmStringCreateLtoR;, +&cdeman.XmStringCreateSimple;, +&cdeman.XmStringDirection;, +&cdeman.XmStringDirectionCreate;, +&cdeman.XmStringDraw;, +&cdeman.XmStringDrawImage;, +&cdeman.XmStringDrawUnderline;, +&cdeman.XmStringEmpty;, +&cdeman.XmStringExtent;, +&cdeman.XmStringFree;, +&cdeman.XmStringFreeContext;, +&cdeman.XmStringGetLtoR;, +&cdeman.XmStringGetNextComponent;, +&cdeman.XmStringGetNextSegment;, +&cdeman.XmStringHasSubstring;, +&cdeman.XmStringHeight;, +&cdeman.XmStringInitContext;, +&cdeman.XmStringLength;, +&cdeman.XmStringLineCount;, +&cdeman.XmStringNConcat;, +&cdeman.XmStringNCopy;, +&cdeman.XmStringPeekNextComponent;, +&cdeman.XmStringSegmentCreate;, +&cdeman.XmStringSeparatorCreate;, +&cdeman.XmStringTable;, and +&cdeman.XmStringWidth;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrB.sgm new file mode 100644 index 00000000..d66718ce --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrB.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmStringCreateLocalized +library call + + +XmStringCreateLocalized +A compound string function that creates +a compound string in the current locale + +XmStringCreateLocalized + +compound string functions +XmStringCreateLocalized + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringCreateLocalized + +char *text + + + +DESCRIPTION +XmStringCreateLocalized creates a compound string containing +the specified text in the current language environment. +An identical compound string would result +from the function XmStringCreate called with +XmFONTLIST_DEFAULT_TAG explicitly as the tag component. + +The function will allocate space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +text + +Specifies a NULL-terminated string of text encoded in the current +language environment +to be used as the text component of the compound string + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrC.sgm new file mode 100644 index 00000000..5d67d9c1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrC.sgm @@ -0,0 +1,112 @@ + + + + + + + + + + + +XmStringCreateLtoR +library call + + +XmStringCreateLtoR +A compound string function that creates a compound string + +XmStringCreateLtoR + +compound string functions +XmStringCreateLtoR + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringCreateLtoR + +char *text +char *tag + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringGenerate. +XmStringCreateLtoR creates a compound +string with two components: text and a +tag component. +This function +scans +for \n +characters in the text. When one is found, the text up to that point +is put into a segment followed by a separator component. No final +separator component is appended to the end of the compound string. +The direction +component +defaults to left-to-right. +This function assumes that the encoding is single +byte +rather than +multibyte. + +The function will allocate space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +text + +Specifies a NULL-terminated string to be used as the text component of +the compound string. + + + + +tag + +Specifies the tag component to be associated with the given +text. The value XmFONTLIST_DEFAULT_TAG is retained for +compatibility with previous releases. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate; +and &cdeman.XmStringGenerate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrD.sgm new file mode 100644 index 00000000..a4c3dd61 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrCrD.sgm @@ -0,0 +1,97 @@ + + + + + + + + + + + +XmStringCreateSimple +library call + + +XmStringCreateSimple +A compound string function that creates a compound string in the language environment of a widget + +XmStringCreateSimple + +compound string functions +XmStringCreateSimple + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringCreateSimple + +char * text + + + +DESCRIPTION +XmStringCreateSimple creates a compound +string with a text component and a charset tag. +It derives the character set from the current language environment. + +The routine attempts to derive a character set from the value of the +LANG environment variable. +If this does not result in a valid character set, the routine uses a +vendor-specific default. +If the vendor has not specified a different value, this default is +ISO8859-1. + +The function will allocate space to hold the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + +NOTE: This routine is obsolete and exists for compatibility with previous +releases. It has been replaced by XmStringCreateLocalized. + + + +text + +Specifies a NULL-terminated string to be used as the text component of +the compound string. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate; and +&cdeman.XmStringCreateLocalized;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiA.sgm new file mode 100644 index 00000000..c1f0e64c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiA.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmStringDirection +library call + + +XmStringDirection +Data type for the direction of display in a string + +XmStringDirection + +data types +XmStringDirection + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmStringDirection +is the data type for specifying the direction in which the system +displays characters of a string, or characters of a segment of a +compound string. +This is an enumeration with three possible values: + + + +XmSTRING_DIRECTION_L_TO_R + +Specifies left to right display + + + + +XmSTRING_DIRECTION_R_TO_L + +Specifies right to left display + + + + +XmSTRING_DIRECTION_DEFAULT + +Specifies that the display direction will be set by the widget in +which the compound string is to be displayed. + + + + + + +RELATED +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiB.sgm new file mode 100644 index 00000000..74b09ffe --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiB.sgm @@ -0,0 +1,107 @@ + + + + + + + + + + + +XmStringDirectionCreate +library call + + +XmStringDirectionCreate +A compound string function that creates a compound string + +XmStringDirectionCreate + +compound string functions +XmStringDirectionCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringDirectionCreate + +XmStringDirection direction + + + +DESCRIPTION +XmStringDirectionCreate creates a compound string with a single component, +a direction with the given value. +When the application no longer needs the returned compound string, the +application should call XmStringFree. + + + +direction + +Specifies the value of the direction component. +The possible values are: + + + +XmSTRING_DIRECTION_L_TO_R + +Specifies left to right display. + + + + +XmSTRING_DIRECTION_R_TO_L + +Specifies right to left display. + + + + +XmSTRING_DIRECTION_DEFAULT + +Specifies that the display direction will be set by the widget in +which the compound string is to be displayed. + + + + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiC.sgm new file mode 100644 index 00000000..a77ed8cc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDiC.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmStringDirectionToDirection +library call + + +XmStringDirectionToDirection +A function that converts from XmStringDirection to XmDirection + +XmStringDirectionToDirection + + + + + + + + + + + +#include <Xm/Xm.h> + +XmDirection XmStringDirectionToDirection + +XmStringDirection direction + + + +DESCRIPTION +XmStringDirectionToDirection converts the specified +XmStringDirection +direction value to its equivalent XmDirection value. This +function provides backward compatibility with the +XmStringDirection data type. + + + +direction + +Specifies the XmStringDirection value to be converted. + + + + + + +RETURN +Returns the following XmDirection values: + + + +XmLEFT_TO_RIGHT + +If the direction argument is XmSTRING_DIRECTION_L_TO_R. + + + + +XmRIGHT_TO_LEFT + +If the direction argument is XmSTRING_DIRECTION_R_TO_L. + + + + +XmDEFAULT_DIRECTION + +If the direction argument was not either of the above. + + + + + + +RELATED INFORMATION +&cdeman.XmStringDirection; and &cdeman.XmDirection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrA.sgm new file mode 100644 index 00000000..6467c0f5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrA.sgm @@ -0,0 +1,176 @@ + + + + + + + + + + + +XmStringDraw +library call + + +XmStringDraw +A compound string function that draws a compound string in an X window + +XmStringDraw + +compound string functions +XmStringDraw + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringDraw + +Display * d +Window w +XmRenderTable rendertable +XmString string +GC gc +Position x +Position y +Dimension width +unsigned char alignment +unsigned char layout_direction +XRectangle * clip + + + +DESCRIPTION +XmStringDraw draws a compound string in an X Window. +If a compound string segment uses a +rendition +that +contains +a font set, the graphic context passed to this +routine will have the GC font member left in an undefined +state. The underlying XmbStringDraw function called +by this routine modifies the font ID field of the GC passed +into it and does not attempt to restore the font ID to the +incoming value. If the compound string segment is not drawn +using a font set, the graphic context must contain a valid font +member. Graphic contexts created by XtGetGC are not +valid for this routine; instead, use XtAllocateGC +to create a graphic context. + + + +d + +Specifies the display. + + + + +w + +Specifies the window. + + + + +rendertable + +Specifies the render table. + + + + +string + +Specifies the string. + + + + +gc + +Specifies the graphics context to use. + + + + +x + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +y + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +width + +Specifies the width of the rectangle that will contain the +displayed compound string. + + + + +alignment + +Specifies how the string will be aligned within the specified rectangle. +It is either XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER, or +XmALIGNMENT_END. + + + + +layout_direction + +Controls the direction in which the segments of the compound string will +be laid out. It also determines the meaning of the alignment parameter. + + + + +clip + +Allows the application to restrict the area into which the compound string +will be drawn. +If the value is NULL, clipping will be determined by the GC. + + + + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrB.sgm new file mode 100644 index 00000000..75d9d26f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrB.sgm @@ -0,0 +1,178 @@ + + + + + + + + + + + +XmStringDrawImage +library call + + +XmStringDrawImage +A compound string function that draws a compound string in an X Window and creates an image + +XmStringDrawImage + +compound string functions +XmStringDrawImage + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringDrawImage + +Display * d +Window w +XmRenderTable rendertable +XmString string +GC gc +Position x +Position y +Dimension width +unsigned char alignment +unsigned char layout_direction +XRectangle * clip + + + +DESCRIPTION +XmStringDrawImage +draws a compound string in an X Window and paints both the +foreground and background bits of each character. +If a compound string segment uses a +rendition +that +contains +a font set, the graphic context passed to this +routine will have the GC font member left in an undefined +state. The underlying XmbStringDraw function called +by this routine modifies the font ID field of the GC passed +into it and does not attempt to restore the font ID to the +incoming value. If the compound string segment is not drawn using +a font set, the graphic context must contain a valid font +member. Graphic contexts created by XtGetGC are not +accepted by this routine; instead, use XtAllocateGC +to create a graphic context. + + + +d + +Specifies the display. + + + + +w + +Specifies the window. + + + + +rendertable + +Specifies the render table. + + + + +string + +Specifies the string. + + + + +gc + +Specifies the graphics context to use. + + + + +x + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +y + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +width + +Specifies the width of the rectangle that will contain the +displayed compound string. + + + + +alignment + +Specifies how the string will be aligned within the specified rectangle. +It is either XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER, or +XmALIGNMENT_END. + + + + +layout_direction + +Controls the direction in which the segments of the compound string will +be laid out. It also determines the meaning of the alignment parameter. + + + + +clip + +Allows the application to restrict the area into which the compound string +will be drawn. +If NULL, clipping will be determined by the GC. + + + + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrC.sgm new file mode 100644 index 00000000..8e895c6a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrDrC.sgm @@ -0,0 +1,190 @@ + + + + + + + + + + + +XmStringDrawUnderline +library call + + +XmStringDrawUnderline +A compound string function that underlines a string drawn in an X Window + +XmStringDrawUnderline + +compound string functions +XmStringDrawUnderline + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringDrawUnderline + +Display * d +Window w +XmRenderTable rendertable +XmString string +GC gc +Position x +Position y +Dimension width +unsigned char alignment +unsigned char layout_direction +XRectangle * clip +XmString underline + + + +DESCRIPTION +XmStringDrawUnderline draws a compound string in an X Window. If the +substring identified by underline can be matched in string, +the substring will be underlined. Once a match has occurred, no further +matches or underlining will be done. +Only the first text component of underline is used for matching. + +If a compound string segment uses a +rendition +that +contains +a font set, the graphic context passed to this +routine will have the GC font member left in an undefined +state. The underlying XmbStringDraw function called +by this routine modifies the font ID field of the GC passed +into it and does not attempt to restore the font ID to the +incoming value. If the compound string segment is not drawn using +a font set, the graphic context must contain a valid font +member. Graphic contexts created by XtGetGC are not +accepted by this routine; instead, use XtAllocateGC +to create a graphic context. + + + +d + +Specifies the display. + + + + +w + +Specifies the window. + + + + +rendertable + +Specifies the render table. + + + + +string + +Specifies the string. + + + + +gc + +Specifies the graphics context to use. + + + + +x + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +y + +Specifies a coordinate of the rectangle that will contain the displayed +compound string. + + + + +width + +Specifies the width of the rectangle that will contain the +displayed compound string. + + + + +alignment + +Specifies how the string will be aligned within the specified rectangle. +It is one of XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER, or +XmALIGNMENT_END. + + + + +layout_direction + +Controls the direction in which the segments of the compound string will +be laid out. It also determines the meaning of the alignment parameter. + + + + +clip + +Allows the application to restrict the area into which the compound string +will be drawn. +If it is NULL, clipping will be determined by the GC. + + + + +underline + +Specifies the substring to be underlined. + + + + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrEmp.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrEmp.sgm new file mode 100644 index 00000000..8bc74a56 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrEmp.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + + +XmStringEmpty +library call + + +XmStringEmpty +A compound string function that provides information on the existence of non-zero-length text components + +XmStringEmpty + +compound string functions +XmStringEmpty + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringEmpty + +XmString s1 + + + +DESCRIPTION +XmStringEmpty returns a Boolean value indicating whether any +non-zero-length text components exist in the provided compound string. +It returns True +if there are no text segments in the string. If this routine is passed +NULL as the string, it returns True. + + + +s1 + +Specifies the compound string + + + + + + +RETURN +Returns True if there are no text segments in the string. +If this routine is passed +NULL as the string, it returns True. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrExt.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrExt.sgm new file mode 100644 index 00000000..79868913 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrExt.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmStringExtent +library call + + +XmStringExtent +A compound string function that determines the size of the smallest rectangle that will enclose the compound string + +XmStringExtent + +compound string functions +XmStringExtent + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringExtent + +XmRenderTable rendertable +XmString string +Dimension *width +Dimension *height + + + +DESCRIPTION +XmStringExtent determines the width and height, in pixels, of the smallest +rectangle that will enclose the provided compound string. + + + +rendertable + +Specifies the render table + + + + +string + +Specifies the string + + + + +width + +Specifies a pointer to the width of the rectangle + + + + +height + +Specifies a pointer to the height of the rectangle + + + + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrA.sgm new file mode 100644 index 00000000..f7400aa3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrA.sgm @@ -0,0 +1,77 @@ + + + + + + + + + + + +XmStringFree +library call + + +XmStringFree +A compound string function that +conditionally deallocates memory + +XmStringFree + +compound string functions +XmStringFree + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringFree + +XmString string + + + +DESCRIPTION +XmStringFree conditionally recovers memory used by a compound string. +Applications should call XmStringFree when the application +no longer needs string. + + + +string + +Specifies the compound string to be freed + + + + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrB.sgm new file mode 100644 index 00000000..2b973591 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrFrB.sgm @@ -0,0 +1,75 @@ + + + + + + + + + + + +XmStringFreeContext +library call + + +XmStringFreeContext +A compound string function that releases the string scanning context data structure + +XmStringFreeContext + +compound string functions +XmStringFreeContext + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmStringFreeContext + +XmStringContext context + + + +DESCRIPTION +XmStringFreeContext releases the string scanning context data structure. + + + +context + +Specifies the string context structure that was allocated by the +XmStringInitContext function + + + + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringInitContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeA.sgm new file mode 100644 index 00000000..14b984d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeA.sgm @@ -0,0 +1,127 @@ + + + + + + + + + + + +XmStringGenerate +library call + + +XmStringGenerate +A convenience function that generates a compound string + +XmStringGenerate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringGenerate + +XtPointer text +XmStringTag tag +XmTextType type +XmStringTag rendition + + + +DESCRIPTION +XmStringGenerate calls the XmStringParseText +function with a default parse table of entries +consisting of '\n', which maps to +Separator, +and '\t', which maps to Tab. +Matching RENDITION_BEGIN and +RENDITION_END components containing rendition are placed +around the resulting XmString. + + + +text + +Specifies a NULL-terminated string containing characters of a type +determined by type. + + + + +tag + +Specifies the tag to be used in creating the result. The type of tag +created (charset or locale) depends on the text type and the +value given. If specified value is NULL, and type indicates +that a charset tag should be created, then the tag will have the +value of +XmFONTLIST_DEFAULT_TAG. +If tag is NULL, and type indicates a +locale tag, then the tag will have the value of _MOTIF_DEFAULT_LOCALE. + + + + +type + +Specifies the type of text to be passed in, and the tag type. +If a locale tag should be created, then type has a value of +either XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT. If a +charset should be created, type has a value of +XmCHARSET_TEXT. + + + + +rendition + +Specifies the rendition tag to be used in an +XmSTRING_COMPONENT_RENDITION_BEGIN component which will begin +the returned string and in an XmSTRING_COMPONENT_RENDITION_END +component which will end it. +If rendition is NULL, no rendition tag is placed. + + + + + + +RETURN +Returns a new compound string. +The function will allocate space to hold the returned compound string. +When the application no longer needs the returned compound string, the +application should call XmStringFree. + + + +RELATED +&cdeman.XmString; and +&cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeB.sgm new file mode 100644 index 00000000..bee04b3d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeB.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmStringGetLtoR +library call + + +XmStringGetLtoR +A compound string function that searches for a text segment in the input compound string + +XmStringGetLtoR + +compound string functions +XmStringGetLtoR + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringGetLtoR + +XmString string +XmStringCharSet tag +char **text + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringUnparse. +XmStringGetLtoR returns the first text component in the input +compound string that is tagged with the given tag component. The +returned text is to be a NULL-terminated sequence of single byte characters. +If the function returns True, the function will allocate space +to hold the returned text. The application is responsible +for managing the allocated space. The application can recover the +allocated space by calling XtFree. + + + +string + +Specifies the compound string. + + + + +tag + +Specifies the font list element tag associated with the text. +A value of XmFONTLIST_DEFAULT_TAG identifies a locale text +segment. + + + + +text + +Specifies a pointer to a NULL terminated string. + + + + + + +RETURN +Returns True if the matching text segment can be found. +On return, text will have a NULL terminated +byte +sequence +containing the matched segment. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeC.sgm new file mode 100644 index 00000000..2bdcb281 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeC.sgm @@ -0,0 +1,200 @@ + + + + + + + + + + + +XmStringGetNextComponent +library call + + +XmStringGetNextComponent +A compound string function that returns the type and value of the next component in a compound string + +XmStringGetNextComponent + +compound string functions +XmStringGetNextComponent + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmStringComponentType XmStringGetNextComponent + +XmStringContext context +char **text +XmStringTag *tag +XmStringDirection *direction +XmStringComponentType *unknown_tag +unsigned short *unknown_length +unsigned char **unknown_value + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringGetNextTriple. +XmStringGetNextComponent +returns the type and value of the next component in +the compound string identified by context. +Components are returned one at a time. On return, only +some output parameters will be valid; which ones can be determined by +examining the returned component type. +The following table describes the valid returns for each component +type. + + + + + + + +Valid Fields +Component Type + + +tag +XmSTRING_COMPONENT_LOCALE, XmSTRING_COMPONENT_TAG + + +text +XmSTRING_COMPONENT_LOCALE_TEXT, XmSTRING_COMPONENT_TEXT, +XmSTRING_COMPONENT_WIDECHAR_TEXT + + +direction +XmSTRING_COMPONENT_DIRECTION + + +unknown_tag, unknown_length, unknown_value +XmSTRING_COMPONENT_LAYOUT_POP, XmSTRING_COMPONENT_LAYOUT_PUSH, +XmSTRING_COMPONENT_TAB, XmSTRING_COMPONENT_RENDITION_BEGIN, +XmSTRING_COMPONENT_RENDITION_END + + +no valid field +XmSTRING_COMPONENT_SEPARATOR, XmSTRING_COMPONENT_END, +XmSTRING_COMPONENT_UNKNOWN + + + + +Note that several components produce a return value of +XmSTRING_COMPONENT_UNKNOWN. The data returned by these +components is returned in the unknown_tag, unknown_length, +and unknown_value fields. This apparent inconsistency is +designed to accomodate older applications that may not be equipped to +handle the newer component types of Motif version 2.0 and beyond. +Consequently, the use of this procedure is not recommended. Instead, +use the XmStringGetNextTriple procedure, which provides all the +functionality of XmStringGetNextComponent, and is fully +compatible with the newer component types. + +If the function return value is XmSTRING_COMPONENT_LOCALE_TEXT or +XmSTRING_COMPONENT_TEXT, the the function allocates space to hold +the returned text. +If the function return value is XmSTRING_COMPONENT_FONTLIST_ELEMENT_TAG, +or XmSTRING_COMPONENT_TAG, then the function allocates space to hold +the returned tag. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XtFree. + + + +context + +Specifies the string context structure that was allocated by the +XmStringInitContext function. + + + + +text + +Specifies a pointer to a NULL terminated string. + + + + +tag + +Specifies a pointer to the tag component associated with the +text. The value XmFONTLIST_DEFAULT_TAG identifies a locale +text segment. + + + + +direction + +Specifies a pointer to the direction of the text. + + + + +unknown_tag + +Specifies a pointer to the tag of an unknown component. + + + + +unknown_length + +Specifies a pointer to the length of an unknown component. + + + + +unknown_value + +Specifies a pointer to the value of an unknown component. + + + + + + +RETURN +Returns the type of component found. +Refer to the +&cdeman.XmStringComponentType; reference page for a list of component types. + + + +RELATED +&cdeman.XmStringComponentType;, +&cdeman.XmStringCreate;, +and &cdeman.XmStringInitContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeE.sgm new file mode 100644 index 00000000..75e075ef --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeE.sgm @@ -0,0 +1,128 @@ + + + + + + + + + + + +XmStringGetNextSegment +library call + + +XmStringGetNextSegment +A compound string function that fetches the bytes in the next segment of a compound string + +XmStringGetNextSegment + +compound string functions +XmStringGetNextSegment + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringGetNextSegment + +XmStringContext context +char **text +XmStringTag *tag +XmStringDirection *direction +Boolean *separator + + + +DESCRIPTION +This routine is obsolete and exists for compatibility with previous +releases. To read the contents of a compound string, read each +component of the string with XmStringGetNextTriple. This +XmString function returns the type, length, and value of the next +component in the compound string. +XmStringGetNextSegment +fetches the +bytes +in the next segment; repeated calls +fetch sequential segments. The text, tag, +and direction of the fetched segment are returned each time. A +Boolean status is returned to indicate whether a valid segment was +successfully parsed. + +If the function returns True, then the function allocates space to hold the +returned text and tag. The application is responsible for +managing the allocated space. The application can recover the allocated space +by calling XtFree. + + + +context + +Specifies the string context structure which was allocated by the +XmStringInitContext function + + + + +text + +Specifies a pointer to a NULL-terminated string + + + + +tag + +Specifies a pointer to the font list element tag associated with the +text + + + + +direction + +Specifies a pointer to the direction of the text + + + + +separator + +Specifies whether the next component of the compound string is a +separator + + + + + + +RETURN +Returns True if a valid segment is found. + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringInitContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeF.sgm new file mode 100644 index 00000000..4b47ef03 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrGeF.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmStringGetNextTriple +library call + + +XmStringGetNextTriple +An XmString function that returns the type, length, and value of the next component in the compound string + +XmStringGetNextTriple + + + + + + + + + + +#include <Xm/Xm.h> + +XmStringComponentType XmStringGetNextTriple + +XmStringContext context +unsigned int *length +XtPointer *value + + + +DESCRIPTION +XmStringGetNextTriple returns the type, length, and value of the +next component in the compound string identified by context. +This function returns one component at a time. + + + +context + +Specifies the string context structure that was allocated by the +XmStringInitContext function. + + + + +length + +Specifies a pointer to the length of the value of the returned component. + + + + +value + +Specifies a pointer to the value of the returned component. +If the returned value is not NULL, the function allocates space to hold +the returned value. +When the application no longer needs the returned compound string, +the application should call +XtFree. + + + + + + +RETURN +Returns the type of the component found. Refer to the +&cdeman.XmStringComponentType; reference page for a list of component types. + + + +RELATED +&cdeman.XmDirection;, +&cdeman.XmString;, +&cdeman.XmStringComponentType;, +&cdeman.XmStringGetNextComponent;, and +&cdeman.XmStringPeekNextTriple;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHas.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHas.sgm new file mode 100644 index 00000000..80b8033c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHas.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmStringHasSubstring +library call + + +XmStringHasSubstring +A compound string function that indicates whether one compound string is contained within another + +XmStringHasSubstring + +compound string functions +XmStringHasSubstring + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringHasSubstring + +XmString string +XmString substring + + + +DESCRIPTION +XmStringHasSubstring +indicates whether or not one compound string is contained within +another. + + + +string + +Specifies the compound string to be searched + + + + +substring + +Specifies the compound string to be searched for + + + + + + +RETURN +Returns True if +substring +has a single text component and if its text is completely contained within any +single text component of string; otherwise, it returns False. + + + +RELATED +&cdeman.XmStringCreate; and +&cdeman.XmStringCreateLocalized;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHei.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHei.sgm new file mode 100644 index 00000000..1b092518 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrHei.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmStringHeight +library call + + +XmStringHeight +A compound string function that returns the line height of the given compound string + +XmStringHeight + +compound string functions +XmStringHeight + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Dimension XmStringHeight + +XmRenderTable rendertable +XmString string + + + +DESCRIPTION +XmStringHeight +returns the height, in pixels, of the sum of all the line heights +of the given +compound string. Separator components delimit lines. + + + +rendertable + +Specifies the render table + + + + +string + +Specifies the string + + + + + + +RETURN +Returns the height of the specified string. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIni.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIni.sgm new file mode 100644 index 00000000..75ad9f03 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIni.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmStringInitContext +library call + + +XmStringInitContext +A compound string function that creates a data structure for scanning an XmString component by component + +XmStringInitContext + +compound string functions +XmStringInitContext + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringInitContext + +XmStringContext * context +XmString string + + + +DESCRIPTION +XmStringInitContext +creates a context to allow applications to read out the +contents of a compound string component by component. +A Boolean status is returned to indicate that the context could not be +initalized. + +If the function returns True, the function will allocate space to hold the +returned context. The application is responsible for managing the allocated +space. The memory can be recovered by calling XmStringFreeContext. + + + +context + +Specifies a pointer to the allocated context + + + + +string + +Specifies the string + + + + + + +RETURN +Returns True if the context was allocated + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIsV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIsV.sgm new file mode 100644 index 00000000..b309f338 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrIsV.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + + +XmStringIsVoid +library call + + +XmStringIsVoid +A compound string function that provides information on the existence of non-zero-length text components, tab components, or separator components + +XmStringIsVoid + +compound string functions +XmStringIsVoid + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmStringIsVoid + +XmString s1 + + + +DESCRIPTION +XmStringIsVoid returns a Boolean value indicating whether +or not string s1 is void. + + + +s1 + +Specifies the compound string + + + + + + +RETURN +Returns True if any non-zero-length +text components, +tab components, +or separator components +exist in s1. +That is, the function returns True if the string has +no text, tabs, or separators. +If s1 contains the NULL string, the function returns True. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLen.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLen.sgm new file mode 100644 index 00000000..f8f4af6a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLen.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmStringLength +library call + + +XmStringLength +A compound string function that obtains the length of a compound string + +XmStringLength + +compound string functions +XmStringLength + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +int XmStringLength + +XmString s1 + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringByteStreamLength. +XmStringLength +obtains the length of a compound string. It returns the number +of bytes in s1 including all tags, direction indicators, and +separators. If the compound string has an invalid structure, 0 (zero) is +returned. + + + +s1 + +Specifies the compound string + + + + + + +RETURN +Returns the length of the compound string. + + + +RELATED +&cdeman.XmStringByteStreamLength; and +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLin.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLin.sgm new file mode 100644 index 00000000..1ad9888a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrLin.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmStringLineCount +library call + + +XmStringLineCount +A compound string function that returns the number of separators plus one in the provided compound string + +XmStringLineCount + +compound string functions +XmStringLineCount + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +int XmStringLineCount + +XmString string + + + +DESCRIPTION +XmStringLineCount +returns the number of separators plus one in the provided +compound string. In effect, it counts the lines of text. + + + +string + +Specifies the string + + + + + + +RETURN +Returns the number of lines in the compound string. +If string is empty, the function returns 1. If NULL is passed +into string, the function returns 0 (zero). + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCA.sgm new file mode 100644 index 00000000..e5663a70 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCA.sgm @@ -0,0 +1,107 @@ + + + + + + + + + + + +XmStringNConcat +library call + + +XmStringNConcat +A compound string function that appends a specified number of bytes to a compound string + +XmStringNConcat + +compound string functions +XmStringNConcat + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringNConcat + +XmString s1 +XmString s2 +int num_bytes + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringConcat. +XmStringNConcat appends a specified number of bytes from s2 to +the end of s1, including tags, directional indicators, and +separators. It then returns the +resulting compound string. The original strings are preserved. +The function allocates space for the resulting compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +s1 + +Specifies the compound string to which a copy of s2 is appended. + + + + +s2 + +Specifies the compound string that is appended to the end of s1. + + + + +num_bytes + +Specifies the number of bytes of s2 to append to s1. +If this value is less than the +length of s2, as many bytes as possible, but possibly fewer than +this value, will be appended to s1 such that the resulting string +is still a valid compound string. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCB.sgm new file mode 100644 index 00000000..1c404753 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrNCB.sgm @@ -0,0 +1,99 @@ + + + + + + + + + + + +XmStringNCopy +library call + + +XmStringNCopy +A compound string function that creates a copy of a compound string + +XmStringNCopy + +compound string functions +XmStringNCopy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringNCopy + +XmString s1 +int num_bytes + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. +XmStringNCopy creates a copy of s1 that contains a specified +number of bytes, including tags, directional indicators, +and separators. It then returns the +resulting compound string. The original strings are preserved. +The function allocates space for the resulting compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +s1 + +Specifies the compound string. + + + + +num_bytes + +Specifies the number of bytes of s1 to copy. +If this value is less than the +length of s1, as many bytes as possible, but possibly fewer than +this value, will be appended to s1 such that the resulting string +is still a valid compound string. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate; and &cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPar.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPar.sgm new file mode 100644 index 00000000..c01e9d1e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPar.sgm @@ -0,0 +1,171 @@ + + + + + + + + + + + +XmStringParseText +library call + + +XmStringParseText +A function that converts a character string to a compound string + +XmStringParseText + +compound string functions +XmStringParseText + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringParseText + +XtPointer text +XtPointer *text_end +XmStringTag tag +XmTextType type +XmParseTable parse_table +Cardinal parse_count +XtPointer call_data + + + +DESCRIPTION +XmStringParseText converts characters specified in text to +corresponding components in the returned compound string. The +resulting compound string consists of at least one locale or charset +tag component and a series of XmString text components and other +components. The conversion proceeds according to the parse information +contained in parse_table. See the &MotifProgGd; for more information +about parsing and parse tables. + + + +If type is XmCHARSET_TEXT, the associated tag is +interpreted as a charset name. +If tag has a value of NULL, a charset component whose value +is the result of mapping +XmFONTLIST_DEFAULT_TAG +is created. + + + +If type is XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT, the +associated tag is interpreted as a language environment name. +If tag has a value of NULL, a locale component with a value of +_MOTIF_DEFAULT_LOCALE is created. +If type is XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT, +tag must be NULL or _MOTIF_DEFAULT_LOCALE. + + + +XmStringParseText also scans the string for characters that have +matches in parse_table. +Whenever a match is found, the text up to that point is concatenated +with the mapped component. + + + +text + +Specifies the NULL-terminated string containing characters of a type +determined by type. +This is updated to point to after the last character scanned. + + + + +text_end + +Specifies a pointer into text. If a NULL is supplied to the +text_end parameter, then XmStringParseText parses +text until NULL is encountered, or until it reaches a point in +text +where it is directed to stop +(for example, by a parse_proc). Otherwise, the value supplied +to the text_end parameter is the pointer into text where +parsing is to stop, and the returned character is the one where +parsing did stop. + + + + +tag + +Specifies the tag to be used in creating the result. +The type of string tag created (charset or locale) depends on the text +type and the passed in tag value. +If the tag value is NULL and if type indicates that a +charset string tag should be created, the string tag has the value +that is the result of mapping +XmFONTLIST_DEFAULT_TAG. +If type indicates a locale string tag, the string tag has the +value _MOTIF_DEFAULT_LOCALE. + + + + +type + +Specifies the type of text and the tag type. +If a locale tag should be created, type has a value of either +XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT. +If type has value of +XmCHARSET_TEXT, a charset tag will be created. + + + + +parse_table + +Specifies the parse table to be used in scanning for characters to be +converted to other compound string components. + + + + +parse_count + +Specifies the number of entries in parse_table. + + + + +call_data + +Specifies data to be passed to the parse procedures. + + + + + + +RETURN +Returns a new compound string. +The function allocates space to hold the returned compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +RELATED +&cdeman.XmString;, +&cdeman.XmStringFree;, &cdeman.XmParseTable;, &cdeman.XmParseMapping;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeA.sgm new file mode 100644 index 00000000..edf39655 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeA.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmStringPeekNextComponent +library call + + +XmStringPeekNextComponent +A compound string function that returns the component type of the next component to be fetched + +XmStringPeekNextComponent + +compound string functions +XmStringPeekNextComponent + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmStringComponentType XmStringPeekNextComponent + +XmStringContext context + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It is replaced by XmStringPeekNextTriple. +XmStringPeekNextComponent +examines the next component that would be fetched +by XmStringGetNextComponent and returns the component type. + + + +context + +Specifies the string context structure that was allocated by the +XmStringInitContext function + + + + + + +RETURN +Returns the type of component found. +Refer to the +&cdeman.XmStringComponentType; reference page for a list of component types. + + + +RELATED +&cdeman.XmStringComponentType;, +&cdeman.XmStringCreate;, +&cdeman.XmStringGetNextComponent;, and +&cdeman.XmStringInitContext;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeB.sgm new file mode 100644 index 00000000..787ef29c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPeB.sgm @@ -0,0 +1,69 @@ + + + + + + + + + + + +XmStringPeekNextTriple +library call + + +XmStringPeekNextTriple +A function that returns the component type of the next component + +XmStringPeekNextTriple + + + + + + + + + + + +#include <Xm/Xm.h> + +XmStringComponentType XmStringPeekNextTriple + +XmStringContext context + + + +DESCRIPTION +XmStringPeekNextTriple examines the next component that would be fetched +by XmStringGetNextTriple and returns the component type. + + + +context + +Specifies the string context structure that was allocated by the +XmStringInitContext function. + + + + + + +RETURN +Returns the type of the component found. +Refer to the +&cdeman.XmStringComponentType; reference page for a list of component types. + + + +RELATED +&cdeman.XmString;, +&cdeman.XmStringComponentType;, and +&cdeman.XmStringGetNextTriple;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPut.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPut.sgm new file mode 100644 index 00000000..8a7e8a52 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrPut.sgm @@ -0,0 +1,81 @@ + + + + + + + + + + + +XmStringPutRendition +library call + + +XmStringPutRendition +A convenience function that places renditions around strings + +XmStringPutRendition + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringPutRendition + +XmString string +XmStringTag rendition + + + +DESCRIPTION +XmStringPutRendition places matching +Xm_STRING_COMPONENT_RENDITION_BEGIN and +XmSTRING_COMPONENT_RENDITION_END components containing +rendition around +string. The original string is preserved. + + + +string + +Specifies the compound string to which begin and end rendition +components should be added. + + + + +rendition + +Specifies the rendition tag to be used in an +XmSTRING_COMPONENT_RENDITION_BEGIN component which will begin +the returned string and in an XmSTRING_COMPONENT_RENDITION_END +component which will end it. + + + + + + +RETURN +Returns a new compound string. +The function allocates space to hold this returned compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +RELATED +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSeg.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSeg.sgm new file mode 100644 index 00000000..ae9b2103 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSeg.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmStringSegmentCreate +library call + + +XmStringSegmentCreate +A compound string function that creates a compound string + +XmStringSegmentCreate + +compound string functions +XmStringSegmentCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringSegmentCreate + +char * text +XmStringTag tag +XmStringDirection direction +Boolean separator + + + +DESCRIPTION +This function is obsolete and exists for compatibility with previous +releases. It can be replaced by using a combination of +XmStringComponentCreate and XmStringConcat. +XmStringSegmentCreate is a high-level function that assembles a compound +string consisting of a font list element tag, a direction component, +a text component, and an optional separator component. + +The function allocates space for the returned compound string. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmStringFree. + + + +text + +Specifies a NULL-terminated string to be used as the text component of +the compound string. + + + + +tag + +Specifies the tag component to be associated with the text. +The value XmFONTLIST_DEFAULT_TAG is for compatibility with +previous releases. + + + + +direction + +Specifies the direction of the text. + + + + +separator + +A value of False means +the compound string does not +have a separator at the end. A value of True, means a separator immediately +follows the text component. + + + + + + +RETURN +Returns a new compound string. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSep.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSep.sgm new file mode 100644 index 00000000..f4c2fa68 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrSep.sgm @@ -0,0 +1,73 @@ + + + + + + + + + + + +XmStringSeparatorCreate +library call + + +XmStringSeparatorCreate +A compound string function that creates a compound string + +XmStringSeparatorCreate + +compound string functions +XmStringSeparatorCreate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringSeparatorCreate + + + + +DESCRIPTION +XmStringSeparatorCreate +creates a compound string with a single component, +a separator. + + + +RETURN +Returns a new compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaA.sgm new file mode 100644 index 00000000..aefd248a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaA.sgm @@ -0,0 +1,62 @@ + + + + + + + + + + + +XmStringTable +library call + + +XmStringTable +Data type for an array of compound strings + +XmStringTable + +data types +XmStringTable + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmStringTable +is the data type for an array of compound strings +(objects of type +XmString). + + + +RELATED +&cdeman.XmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaB.sgm new file mode 100644 index 00000000..6c8f2088 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaB.sgm @@ -0,0 +1,135 @@ + + + + + + + + + + + +XmStringTableParseStringArray +library call + + +XmStringTableParseStringArray +A convenience function that converts an array of strings to a compound string table + +XmStringTableParseStringArray + + + + + + + + + + + +#include <Xm/Xm.h> + +XmStringTable XmStringTableParseStringArray + +XtPointer *strings +Cardinal count +XmStringTag tag +XmTextType type +XmParseTable parse +Cardinal parse_count +XtPointer call_data + + + +DESCRIPTION +XmStringTableParseStringArray takes an array of strings, +allocates an XmStringTable with an equal number of slots, calls +XmStringParseText on each string in strings, and inserts +the resulting XmString in the corresponding slot in the +XmStringTable. + + + +strings + +Specifies an array of strings of characters as determined by +type. + + + + +count + +Specifies the number of strings in strings. + + + + +tag + +Specifies the tag to be used in creating the result. The type of tag +created (charset or locale) depends on the type of the text and +the value given. If the value specified is NULL, and type +indicates that a charset tag should be created, then the tag will +have the value of +XmFONTLIST_DEFAULT_TAG. +If type +indicates a locale tag, then the tag will have the value of +XmFONTLIST_DEFAULT_TAG. + + + + +type + +Specifies the type of text to be passed in and the type of tag. If +the type is either XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT, a +locale tag should be created. If the type is XmCHARSET_TEXT, a +charset tag +will +be created. + + + + +parse + +Specifies the parse table to be used. + + + + +parse_count + +Specifies the number of entries in the parse table. + + + + +call_data + +Specifies data to be passed to the parse procedures. + + + + + + +RETURN +Returns a new XmStringTable. +The function allocates space to hold the XmStringTable. +When the application no longer needs the returned XmStringTable, +the application should call XmStringFree +count times (that is, one time for each returned compound string) +and then call XtFree to deallocate the XmStringTable itself. + + + +RELATED +&cdeman.XmStringFree; and +&cdeman.XmTabList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaC.sgm new file mode 100644 index 00000000..8e99881f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaC.sgm @@ -0,0 +1,118 @@ + + + + + + + + + + + +XmStringTableProposeTablist +library call + + +XmStringTableProposeTablist +A convenience function that returns a tab list + +XmStringTableProposeTablist + + + + + + + + + + +#include <Xm/Xm.h> + +XmTabList XmStringTableProposeTablist + +XmStringTable strings +Cardinal num_strings +Widget widget +float pad_value +XmOffsetModel offset_model + + + +DESCRIPTION +XmStringTableProposeTablist takes an XmStringTable +structure containing tabbed compound strings, information on padding +between columns, and rendering information and returns a tab list +that, if used to render the strings in the table, would cause the +strings to line up in columns with no overlap and with the specified +amount of padding between the widest item in each column and the start +of the next column. Each tab in the tablist would have the same unit +type as units, an offset model of offset_model, and an +alignment type of XmALIGNMENT_BEGINNING. + + + +strings + +Specifies an array of compound strings. + + + + +num_strings + +Specifies the number of compound strings in strings. + + + + +widget + +Specifies the widget used for deriving any necessary information for +creating the rendition. In particular, the XmNunitType of +widget will be used to specify the unit type +to be used in determining the amount of padding +separating columns and for the tabs in the proposed tab list. Also, +widget's render table will be used in interpreting rendition +tags within the strings. + + + + +pad_value + +Specifies the value of the amount of padding to be used to separate +columns. +The units for this parameter are specified as +the XmNunitType set for the widget parameter. +Refer to the XmNunitType resource of the +XmGadget, XmManager, or XmPrimitive reference page. + + + + +offset_model + +Specifies the offset model to be used in creating the tabs. Can be +XmABSOLUTE or XmRELATIVE. + + + + + + +RETURN +Returns a new XmTabList. +The function allocates space to hold the returned tab list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmTabListFree. + + + +RELATED +&cdeman.XmTabList; and +&cdeman.XmTabListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaD.sgm new file mode 100644 index 00000000..bd01fdd9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaD.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmStringTableToXmString +library call + + +XmStringTableToXmString +A convenience function that converts a compound string table to a single compound string + +XmStringTableToXmString + + + + + + + + + + +#include <Xm/Xm.h> + +XmString XmStringTableToXmString + +XmStringTable table +Cardinal count +XmString break_component + + + +DESCRIPTION +XmStringTableToXmString takes as input table of compound +strings and a specified +string component (such as a tab) and returns a single compound +string consisting of +each of the elements of table concatenated together with a +single copy of break_component inserted between each element. + + + +table + +Specifies an XmStringTable containing the compound strings to be +converted. + + + + +count + +Specifies the number of compound strings in table. + + + + +break_component + +Specifies the XmStringComponent that will be inserted in the +result to separate the individual elements of table. The most +useful types will be XmSTRING_COMPONENT_SEPARATOR and +XmSTRING_COMPONENT_TAB. +Refer to the +&cdeman.XmStringComponentType; reference page for a complete list of +possible component types. Note, however, that the +XmSTRING_COMPONENT_UNKNOWN component is not a possible type. + + + + + + +RETURN +Returns a new XmString. +The function will allocate space to hold the returned compound string. +When the application no longer needs the returned compound string, +the application should call XmStringFree. + + + +RELATED +&cdeman.XmString;, +&cdeman.XmStringComponentType;, and +&cdeman.XmStringFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaE.sgm new file mode 100644 index 00000000..f30b0cbe --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrTaE.sgm @@ -0,0 +1,182 @@ + + + + + + + + + + + +XmStringTableUnparse +library call + + +XmStringTableUnparse +A convenience function that converts a table of compound strings to an array of text + +XmStringTableUnparse + + + + + + + + + + + +#include <Xm/Xm.h> + +XtPointer * XmStringTableUnparse + +XmStringTable table +Cardinal count +XmStringTag tag +XmTextType tag_type +XmTextType output_type +XmParseTable parse +Cardinal parse_count +XmParseModel parse_model + + + +DESCRIPTION +XmStringTableUnparse takes an array of compound strings, +allocates a string array for the type of characters determined by +type with an equal number of slots, calls +XmStringUnparse +on each compound string in table, +and inserts the resulting string in the corresponding slot in the array. + + + +table + +Specifies an XmStringTable containing the compound string to be +converted. + + + + +count + +Specifies the number of compound strings in table. + + + + +tag + +Specifies the tag to be used in matching with text segments. +The two +types of tag types are XmFONTLIST_DEFAULT_TAG and +_MOTIF_DEFAULT_LOCALE. +Only segments tagged with tag +will be returned. If tag is NULL, all segments will be matched. + + + + +tag_type + +Specifies the type of tag to be searched for. These types include +XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and +XmCHARSET_TEXT. + + + + +output_type + +Specifies the type of text to be generated. These types include +XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and +XmCHARSET_TEXT. + + + + +parse + +Specifies the parse table to be used. + + + + +parse_count + +Specifies the number of items in parse. + + + + +parse_model + +Specifies which non-text components to be considered in matching in +parse_table. Possible values are: + + + +XmOUTPUT_ALL + +Puts out all matching components. + + + + +XmOUTPUT_BETWEEN + +Puts out only those matching components that are between two matching +text components. + + + + +XmOUTPUT_BEGINNING + +Puts out only those matching components that are at the beginning of a +matching text component. + + + + +XmOUTPUT_END + +Puts out only those matching components that are at the end of a +matching text component. + + + + +XmOUTPUT_BOTH + +Puts out only those matching components that are at the beginning or +end of a +matching text component. + + + + + + + + + +RETURN +Returns an allocated array of allocated strings. +The application is responsible for managing the allocated space. +The application can recover the allocated strings space by calling XtFree +count times (that is, one time for each allocated string). +The application can then recover the allocated array by calling +XtFree on the allocated array itself. + + + +RELATED +XmStringTab. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrToX.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrToX.sgm new file mode 100644 index 00000000..6f0c77eb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrToX.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmStringToXmStringTable +library call + + +XmStringToXmStringTable +A convenience function that converts a single compound string to a table of compound strings + +XmStringTableToXmString + + + + + + + + + + +#include <Xm/Xm.h> + +Cardinal XmStringToXmStringTable + +XmString string +XmString break_component +XmStringTable *table + + + +DESCRIPTION +XmStringToXmStringTable takes as input a single compound string +and a specified +string component (such as a tab) and returns a table of compound +strings consisting of portions of string delimited by components +matching break_component. The components marking breaks will +not appear in the resulting table. + + + +string + +Specifies the XmString to be converted. + + + + +break_component + +Specifies the XmStringComponent that will be used to indicate +where to split string to form the individual elements of +table. The most +useful types will be XmSTRING_COMPONENT_SEPARATOR and +XmSTRING_COMPONENT_TAB. Refer to the +&cdeman.XmStringComponentType; +reference page for a complete list of +possible component types. Note, however, that the +XmSTRING_COMPONENT_UNKNOWN component is not a possible type. + + + + +table + +Returns the equivalent XmStringTable. +The function will allocate space to hold the returned XmStringTable. +When the applicaiton no longer needs the returned XmStringTable, +the application should call XmStringFree +once for each compound string in the table, +and then calling XtFree to deallocate the XmStringTable itself. + + + + + + +RETURN +Returns the number of compound strings in table. + + + +RELATED +&cdeman.XmStringTable;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrUnp.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrUnp.sgm new file mode 100644 index 00000000..fab90ac6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrUnp.sgm @@ -0,0 +1,179 @@ + + + + + + + + + + + +XmStringUnparse +library call + + +XmStringUnparse +A compound string function that unparses text + +XmStringUnparse + + + + + + + + + + +#include <Xm/Xm.h> + +XtPointer XmStringUnparse + +XmString string +XmStringTag tag +XmTextType tag_type +XmTextType output_type +XmParseTable parse_table +Cardinal parse_count +XmParseModel parse_model + + + +DESCRIPTION +XmStringUnparse looks in the input string for text +segments that are +tagged with locale or charset tags that match tag. The +tag_type +parameter specifies whether the tag is a locale or charset type. +If tag has a value of NULL, all the segments are matched. When +a text segment is found with a matching tag, it is added to the end of +a resulting string. The characters in the +resulting string are of type output_type. + +XmStringUnparse also checks string for components that +match components in parse_table, and also to see if the +component matches the condition specified by parse_model. If +the string component matches in both checks, then the associated +character is added to the end of the resulting string. + + + +string + +Specifies the XmString to be converted. + + + + +tag + +Specifies the tag to be used in matching with text segments. Only text +segments that match tag will be included in the resulting +string. If tag has a value of NULL, all segments are considered +as +matches, and tag_type is ignored. + + + + +tag_type + +Specifies the type of tag to be searched for, including +XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and +XmCHARSET_TEXT. + + + + +output_type + +Specifies the type of text to be returned in the string, including +XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and +XmCHARSET_TEXT. + + + + +parse_table + +Specifies the parse table to be used in scanning for compound string +components to be +converted to other characters. + + + + +parse_count + +Specifies how many entries are in parse_table. + + + + +parse_model + +Specifies which non-text components to be considered in matching in +parse_table. These include: + + + +XmOUTPUT_ALL + +Puts out all matching components. + + + + +XmOUTPUT_BETWEEN + +Puts out only those matching components that are between two matching +text components. + + + + +XmOUTPUT_BEGINNING + +Puts out only those matching components that are at the beginning of a +matching text component. + + + + +XmOUTPUT_END + +Puts out only those matching components that are at the end of a +matching text component. + + + + +XmOUTPUT_BOTH + +Puts out only those matching components that are at the beginning or end +of a matching text component. + + + + + + + + + +RETURN +Returns a newly allocated string containing characters of a type +determined by output_type. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XtFree. + + + +RELATED +&cdeman.XmString;, &cdeman.XmParseTable;, &cdeman.XmParseMapping;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrWid.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrWid.sgm new file mode 100644 index 00000000..f3e18cff --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/StrWid.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmStringWidth +library call + + +XmStringWidth +A compound string function that returns the width of the widest line in a compound string + +XmStringWidth + +compound string functions +XmStringWidth + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Dimension XmStringWidth + +XmRenderTable rendertable +XmString string + + + +DESCRIPTION +XmStringWidth +returns the width, in pixels, of the widest line +in the provided compound string. + + + +rendertable + +Specifies the render table + + + + +string + +Specifies the string + + + + + + +RETURN +Returns the width of the compound string. + + + +RELATED +&cdeman.XmStringCreate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/String.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/String.sgm new file mode 100644 index 00000000..7f463970 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/String.sgm @@ -0,0 +1,207 @@ + + + + + + + + + + + +XmString +library call + + +XmString +Data type for a compound string + +XmString + +data types +XmString + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmString +is the data type for a compound string. +Compound strings consist of a sequence of components, including, but +not limited to, the following: + + + +XmSTRING_COMPONENT_SEPARATOR + + + +XmSTRING_COMPONENT_TAB + + + +XmSTRING_COMPONENT_LAYOUT_POP + + + +XmSTRING_COMPONENT_DIRECTION + + + +XmSTRING_COMPONENT_LAYOUT_PUSH + + + +XmSTRING_COMPONENT_CHARSET + + + +XmSTRING_COMPONENT_FONTLIST_ELEMENT_TAG + + + +XmSTRING_COMPONENT_LOCALE + + + +XmSTRING_COMPONENT_LOCALE_TEXT + + + +XmSTRING_COMPONENT_TAG + + + +XmSTRING_COMPONENT_TEXT + + + +XmSTRING_COMPONENT_END + + + +XmSTRING_COMPONENT_RENDITION_BEGIN + + + +XmSTRING_COMPONENT_RENDITION_END + + + +XmSTRING_COMPONENT_UNKNOWN + + + +XmSTRING_COMPONENT_WIDECHAR_TEXT + + + +and also a rendition tags table, text, and text component. +When a +compound string is displayed, the rendition tags and the +direction are used to determine how to display the text. + +Calling XtGetValues for a resource whose type is XmString yields a +copy of the compound string resource value. +The application is responsible for using XmStringFree to free the +memory allocated for the copy. + +Please see the XmStringComponentType reference page for more +detail about compound string components, and for a description of the +order in which the components should appear in a compound string. +Refer to the XmRenderTable reference page for a description +of the algorithm that associates the rendition tags used for +displaying a compound string text component with a rendition in a +render table. + + + +RELATED +&cdeman.XmParseMapping;, +&cdeman.XmParseMappingCreate;, +&cdeman.XmParseMappingFree;, +&cdeman.XmParseMappingGetValues;, +&cdeman.XmParseMappingSetValues;, +&cdeman.XmParseTable;, +&cdeman.XmParseTableFree;, +&cdeman.XmStringBaseline;, +&cdeman.XmStringByteCompare;, +&cdeman.XmStringByteStreamLength;, +&cdeman.XmStringCompare;, +&cdeman.XmStringComponentCreate;, +&cdeman.XmStringComponentType;, +&cdeman.XmStringConcat;, +&cdeman.XmStringConcatAndFree;, +&cdeman.XmStringCopy;, +&cdeman.XmStringCreate;, +&cdeman.XmStringCreateLocalized;, +&cdeman.XmStringCreateLtoR;, +&cdeman.XmStringCreateSimple;, +&cdeman.XmStringDirection;, +&cdeman.XmStringDirectionCreate;, +&cdeman.XmStringDirectionToDirection;, +&cdeman.XmStringDraw;, +&cdeman.XmStringDrawImage;, +&cdeman.XmStringDrawUnderline;, +&cdeman.XmStringEmpty;, +&cdeman.XmStringExtent;, +&cdeman.XmStringFree;, +&cdeman.XmStringFreeContext;, +&cdeman.XmStringGenerate;, +&cdeman.XmStringGetLtoR;, +&cdeman.XmStringGetNextComponent;, +&cdeman.XmStringGetNextSegment;, +&cdeman.XmStringGetNextTriple;, +&cdeman.XmStringHasSubstring;, +&cdeman.XmStringHeight;, +&cdeman.XmStringInitContext;, +&cdeman.XmStringIsVoid;, +&cdeman.XmStringLength;, +&cdeman.XmStringLineCount;, +&cdeman.XmStringNConcat;, +&cdeman.XmStringNCopy;, +&cdeman.XmStringParseText;, +&cdeman.XmStringPeekNextComponent;, +&cdeman.XmStringPeekNextTriple;, +&cdeman.XmStringPutRendition;, +&cdeman.XmStringSegmentCreate;, +&cdeman.XmStringSeparatorCreate;, +&cdeman.XmStringTable;, +&cdeman.XmStringTableParseStringArray;, +&cdeman.XmStringTableProposeTablist;, +&cdeman.XmStringTableToXmString;, +&cdeman.XmStringTableUnparse;, +&cdeman.XmStringToXmStringTable;, +&cdeman.XmStringUnparse;, +&cdeman.XmStringWidth;, +&cdeman.XmCvtXmStringToByteStream;, +&cdeman.XmCvtXmStringToCT;, +&cdeman.XmCvtCTToXmString;, and +&cdeman.XmCvtByteStreamToXmString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Tab.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Tab.sgm new file mode 100644 index 00000000..6cf459b5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Tab.sgm @@ -0,0 +1,55 @@ + + + + + + + + + + + +XmTab +library call + + +XmTab +Data type for a tab stop + +XmTab + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +XmTab + + + +DESCRIPTION +XmTab is a data structure that specifies a tab stop to be used +in rendering an XmString containing tab components. An +XmTab value contains a value, a unit type, an offset model +(either XmABSOLUTE or XmRELATIVE), an alignment model +(XmALIGNMENT_BEGINNING), +and a decimal point +character. The resource file syntax for XmTab is specified in +the XmTabList reference page. + + + +RELATED +&cdeman.XmTabCreate;, +&cdeman.XmTabFree;, +&cdeman.XmTabGetValues;, +&cdeman.XmTabList;, and +&cdeman.XmTabSetValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabCre.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabCre.sgm new file mode 100644 index 00000000..dd66e2f4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabCre.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmTabCreate +library call + + +XmTabCreate +A convenience function that creates a tab stop + +XmTabCreate + + + + + + + + + + +#include <Xm/Xm.h> + +XmTab XmTabCreate + +float value +unsigned char units +XmOffsetModel offset_model +unsigned char alignment +char *decimal + + + +DESCRIPTION +XmTabCreate creates a tab stop at a position defined by the +value and units arguments. + + + +value + +Specifies the floating point value to be used in conjunction +with units to calculate the location of the tab stop. +Note that negative values are not permitted. + + + + +units + +Specifies the unit type (for example, XmMILLIMETERS) +to be used in conjunction with value +to calculate the location of the tab stop. You can specify +any unit described by the XmConvertUnits reference page. +For resources of type, dimension, or position, you can specify units +as described in the XmNunitType resource of the +XmGadget, XmManager, or XmPrimitive reference page. + + + + +offset_model + +Specifies whether the tab value represents an absolute position or a +relative offset from the previous tab. Valid values are +XmABSOLUTE and XmRELATIVE. + + + + +alignment + +Specifies how the text should be aligned relative to this tab stop. +Valid values are XmALIGNMENT_BEGINNING. + + + + +decimal + +Specifies the multibyte character in the current language environment +to be used as the decimal point for a decimal aligned tab stop. This +is currently unused. + + + + + + +RETURN +Returns a newly allocated XmTab. +The application is responsible for managing this allocated space. +The application can recover this allocated space by calling XmTabFree. + + + +RELATED +&cdeman.XmTab; and +&cdeman.XmTabFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabFree.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabFree.sgm new file mode 100644 index 00000000..40024ed3 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabFree.sgm @@ -0,0 +1,57 @@ + + + + + + + + + + + +XmTabFree +library call + + +XmTabFree +A convenience function that frees a tab + +XmTabFree + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTabFree + +XmTab tab + + + +DESCRIPTION +XmTabFree frees the memory associated with the specified tab. + + + +tab + +Specifies the tab to be freed. + + + + + + +RELATED +&cdeman.XmTab;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabGetV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabGetV.sgm new file mode 100644 index 00000000..9207b505 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabGetV.sgm @@ -0,0 +1,103 @@ + + + + + + + + + + + +XmTabGetValues +library call + + +XmTabGetValues +A convenience function that returns tab values + +XmTabGetValues + + + + + + + + + + +#include <Xm/Xm.h> + +float XmTabGetValues + +XmTab tab +unsigned char *units +XmOffsetModel *offset +unsigned char *alignment +char **decimal + + + +DESCRIPTION +XmTabGetValues takes an XmTab structure, returns the +floating point number that is set as the value of the tab, and then +sets values for the units, offset, alignment, and +decimal arguments where they are not NULL. The returned floating +point number represents the distance that the rendering of the +XmString segment associated with tab will be offset. The +offset is from either the +beginning of the rendering or from the previous tab stop, depending on +the setting for the offset model. The +distance will use the unit type pointed at by unit. + + + +tab + +Specifies the tab to get the value from. + + + + +units + +Specifies a pointer to the unit type. + + + + +offset + +Specifies a pointer to the offset model. + + + + +alignment + +Specifies a pointer to the alignment type. + + + + +decimal + +Specifies a pointer to the multibyte character used as the decimal point. + + + + + + +RETURN +Returns a floating point number that is set as the value of the tab. + + + +RELATED +&cdeman.XmTab;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabList.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabList.sgm new file mode 100644 index 00000000..76919f70 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabList.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmTabList +library call + + +XmTabList +Data type for a tab list + +XmTabList + + + + + + + + + +&npzwc;#include <Xm/Xm.h> +XmTabList + + + +DESCRIPTION +XmTabList is the data type for a tab list. A tab list consists +of tab stop list entries (XmTabs). Whenever a tab component is +encountered while an XmString is being rendered, the origin of +the next X draw depends on the next XmTab. If a tab stop would +cause text to overlap, the x position for the segment is reset to +follow immediately after the end of the previous segment. + +Tab lists are specified in resource files with the following syntax: + +resource_spec: tab WHITESPACE [, WHITESPACE tab ]* + +The resource value string consists of one or more tabs separated by +commas. Each tab identifies the value of the tab, the unit +type, and whether the offset is relative or absolute. For example: + +tab := float [ WHITESPACE units ] +float := [ sign ] [[ DIGIT]*. ]DIGIT+ +sign := + + +where the presence or absence of sign indicates, respectively, a +relative offset or an absolute offset. Note that negative tab values +are not allowed. units indicates the unitType to use as +described in the XmConvertUnits reference page. + +For example, the following specifies a tab list consisting of a one +inch absolute tab followed by a one inch relative tab: + + +*tabList: 1in, +1in + + +For resources of type, dimension, or position, you can specify units +as described in the XmNunitType resource of the +XmGadget, XmManager, or XmPrimitive reference page. + + + +RELATED +Refer to the &MotifProgGd; for more information about tabs and tab lists. +&cdeman.XmTabListCopy;, +&cdeman.XmTabListFree;, +&cdeman.XmTabListGetTab;, +&cdeman.XmTabListInsertTabs;, +&cdeman.XmTabListRemoveTabs;, +&cdeman.XmTabListReplacePositions;, and +&cdeman.XmTabListTabCount;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstCo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstCo.sgm new file mode 100644 index 00000000..f66253f8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstCo.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmTabListCopy +library call + + +XmTabListCopy +A convenience function that creates a new tab list from an existing list + +XmTabListCopy + + + + + + + + + + + +#include <Xm/Xm.h> + +XmTabList XmTabListCopy + +XmTabList tablist +int offset +Cardinal count + + + +DESCRIPTION +XmTabListCopy creates a new tab list consisting of a copy of +a portion of the contents of the tablist argument. This +function starts copying at the specified offset value of the tab list +and copies count values. + + + +tablist + +Specifies a tab list to be copied. + + + + +offset + +Specifies where to start copying. A value of 0 (zero) indicates begin +at the beginning, a value of 1 indicates to skip the first tab, and so +on. A negative indicates to begin counting backwards from the end. +A value of -1 indicates to start copying from the last tab. + + + + +count + +Specifies the number of tabs to copy. A value of 0 (zero) indicates +to copy all elements from the starting point to the end (beginning if +offset is negative) of the tab list. + + + + + + +RETURN +If tablist is NULL, this function returns NULL. Otherwise, +this function returns a newly allocated XmTabList. +If the function does allocate an XmTabList, then the +application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmTabListFree. + + + +RELATED +&cdeman.XmTabList; and +&cdeman.XmTabListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstFr.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstFr.sgm new file mode 100644 index 00000000..a6552c3c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstFr.sgm @@ -0,0 +1,59 @@ + + + + + + + + + + + +XmTabListFree +library call + + +XmTabListFree +A convenience function that frees the memory of a new tab list + +XmTabListFree + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTabListFree + +XmTabList tablist + + + +DESCRIPTION +XmTabListFree recovers memory used by a tab list. In addition, +this function frees all contained tabs. If the tablist is NULL, +the function returns immediately. + + + +tablist + +Specifies the tab list to be freed. + + + + + + +RELATED +&cdeman.XmTabList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstGe.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstGe.sgm new file mode 100644 index 00000000..0dc04529 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstGe.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmTabListGetTab +library call + + +XmTabListGetTab +A convenience function that returns a copy of a tab + +XmTabListGetTab + + + + + + + + + + +#include <Xm/Xm.h> + +XmTab XmTabListGetTab + +XmTabList tablist +Cardinal position + + + +DESCRIPTION +XmTabListGetTab returns a copy of the tab that is located at the +specified position in the tab list. + + + +tablist + +Specifies the tab list. + + + + +position + +Specifies the position of the tab to be returned. A value of 0 (zero) +returns the first tab in the tab list, a value of 1 returns the second +tab, and so on. + + + + + + +RETURN +Returns a copy of the tab that is located at the specified position in +the tab list. If position is greater than or equal to the +number of tabs in the tab list, this function returns NULL. +The application is responsible for managing the space allocted by +the returned tab copy. The application can recover this allocated +space by calling XmTabFree. + + + +RELATED +&cdeman.XmTabFree; and +&cdeman.XmTabList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstIn.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstIn.sgm new file mode 100644 index 00000000..58f6d5b8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstIn.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmTabListInsertTabs +library call + + +XmTabListInsertTabs +A convenience function that inserts tabs into a tab list + +XmTabListInsertTabs + + + + + + + + + + +#include <Xm/Xm.h> + +XmTabList XmTabListInsertTabs + +XmTabList oldlist +XmTab *tabs +Cardinal tab_count +int position + + + +DESCRIPTION +XmTabListInsertTabs creates a new tab list that includes the +tabs in oldlist. This function copies specified tabs to the +tab list at the given position. The first tab_count tabs of the +tabs array are added to the tab list. If oldlist is NULL, +XmTabListInsertTabs creates a new tab list containing only the +tabs specified. + + + +oldlist + +Specifies the tab list to add the tabs to. +The function deallocates oldlist after extracting the required information. + + + + +tabs + +Specifies a pointer to the tabs to be added to the tab list. +It is the caller's responsibility to free the +tabs in tabs by using XmTabFree. + + + + +tab_count + +Specifies the number of tabs in tabs. + + + + +position + +Specifies the position of the first new tab in the tab list. A value +of 0 (zero) makes the first new tab the first tab in the tab list, a +value of 1 makes it the second tab, and so on. If position is +greater than the number of tabs in oldlist, then the tabs will +be inserted at the end. If position is negative, the count will +be backwards from the end. A value of -1 makes the first new tab +the last tab, and so on. + + + + + + +RETURN +If tabs is NULL or tab_count is 0 (zero), this function returns +oldlist. Otherwise, it returns a new tab list. +The function allocates space to hold the returned tab list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmTabListFree. + + + +RELATED +&cdeman.XmTabList; and +&cdeman.XmTabListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRA.sgm new file mode 100644 index 00000000..36132134 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRA.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmTabListRemoveTabs +library call + + +XmTabListRemoveTabs +A convenience function that removes noncontiguous tabs + +XmTabListRemoveTabs + + + + + + + + + + +#include <Xm/Xm.h> + +XmTabList XmTabListRemoveTabs + +XmTabList oldlist +Cardinal *position_list +Cardinal position_count + + + +DESCRIPTION +XmTabListRemoveTabs removes noncontiguous tabs from a tab list. +The function creates a new tab list by copying the contents of +oldlist and removing all tabs whose corresponding positions +appear in the position_list array. +A warning message +is displayed if a specified position is invalid; for example, if the +value is a number greater than the number of tabs in the tab list. + + + +tablist + +Specifies the tab list. +The function deallocates oldlist and the tabs it contains +after extracting the required information. + + + + +position_list + +Specifies an array of the tab positions to be removed. The position +of the first tab in the list is 0 (zero), the position of the second +tab is 1, and so on. + + + + +position_count + +Specifies the number of elements in the position_list. + + + + + + +RETURN +If oldlist or position_list is NULL, or +position_count is 0 (zero), returns oldlist. Otherwise, +this function returns the new tab list. +The function allocates space to hold the returned tab list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmTabListFree. + + + +RELATED +&cdeman.XmTabList; and +&cdeman.XmTabListFree;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRB.sgm new file mode 100644 index 00000000..40a9dc77 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstRB.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmTabListReplacePositions +library call + + +XmTabListReplacePositions +A convenience function that creates a new tab list with replacement tabs + +XmTabListReplacePositions + + + + + + + + + + +#include <Xm/Xm.h> + +XmTabList XmTabListReplacePositions + +XmTabList oldlist +Cardinal *position_list +XmTab *tabs +Cardinal tab_count + + + +DESCRIPTION +XmTabListReplacePositions creates a new tab list that contains +the contents of oldlist, but with the tabs at the positions in +position_list replaced with copies of the corresponding tabs in +tabs. +A warning message is displayed if a specified position is invalid; +for example, if the value is a number greater than the number of tabs +in the tab list. + +This function deallocates the original tab list after extracting the +required information. It is the caller's responsibility to free the +tabs in tabs by using the XmTabFree function. + + + +oldlist + +Specifies the tab list. +The function deallocates the tab list after extracting the required +information. + + + + +position_list + +Specifies an array of positions of the tabs to be replaced. The +position of the first tab is 0 (zero), the position of the second tab +is 1, and so on. + + + + +tabs + +Specifies an array of the replacement tabs. + + + + +tab_count + +Specifies the number of elements in position_list and tabs. + + + + + + +RETURN +If tabs, oldlist, or position_list is NULL, or +tab_count is 0 (zero), returns +oldlist. Otherwise, this function returns the new tab list. +The function allocates space to hold the returned tab list. +The application is responsible for managing the allocated space. +The application can recover the allocated space by calling XmTabListFree. + + + +RELATED +&cdeman.XmTabList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstTa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstTa.sgm new file mode 100644 index 00000000..e4a7367d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabLstTa.sgm @@ -0,0 +1,63 @@ + + + + + + + + + + + +XmTabListTabCount +library call + + +XmTabListTabCount +A convenience function that counts the number of tabs + +XmTabListTabCount + + + + + + + + + + +#include <Xm/Xm.h> + +Cardinal XmTabListTabCount + +XmTabList tablist + + + +DESCRIPTION +XmTabListTabCount counts the number of tabs in the specified +tablist. + + + +tablist + +Specifies the tab list. + + + + + + +RETURN +Returns the number of tabs in tablist. + + + +RELATED +&cdeman.XmTabList;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabSetV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabSetV.sgm new file mode 100644 index 00000000..cdbea83d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TabSetV.sgm @@ -0,0 +1,75 @@ + + + + + + + + + + + +XmTabSetValue +library call + + +XmTabSetValue +A convenience function that sets a tab stop + +XmTabSetValue + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTabSetValue + +XmTab tab +float value + + + +DESCRIPTION +XmTabSetValue sets the value field of the XmTab +structure associated with tab. + + + +tab + +Specifies the tab to set the value of. + + + + +value + +Specifies the floating point number which represents the distance that +the rendering of the XmString segment associated with tab +will be offset. The offset is from either the beginning of the +rendering or from the previous tab stop, depending on the setting for +the offset model. The distance depends on the tab's unit type. +Note that negative values are not permitted, and that if a tab stop +would cause text to overlap, the x position for the segment is set +immediately after the end of the previous segment. + + + + + + +RELATED +See also the &MotifProgGd; for more information about tabs +and tab lists. +&cdeman.XmTab;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TargetsA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TargetsA.sgm new file mode 100644 index 00000000..12e517d2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TargetsA.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmTargetsAreCompatible +library call + + +XmTargetsAreCompatible +A function that tests +whether the target types match between a drop site and source object + +XmTargetsAreCompatible + +Drag and Drop functions +XmTargetsAreCompatible + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/DragDrop.h> + +Boolean XmTargetsAreCompatible + +Display *display +Atom *export_targets +Cardinal num_export_targets +Atom *import_targets +Cardinal num_import_targets + + + +DESCRIPTION +XmTargetsAreCompatible determines whether the import targets of +the destination match any of the export targets of a source. +If there is at least one target in common, the function returns True. + + + +display + +Specifies the display connection. + + + + +export_targets + +Specifies the list of target atoms associated with the source object. +This resource identifies the selection targets the source +can convert to. + + + + +num_export_targets + +Specifies the number of entries in the list of export targets. + + + + +import_targets + +Specifies the list of targets to be checked against the +XmNexportTargets of the source associated with the +specified DragContext + + + + +num_import_targets + +Specifies the number of entries in the import_targets list. + + + + + + +RETURN +Returns a Boolean value that indicates whether the destination +targets are compatible with the source targets. If there is at +least one target in common, the routine returns True; otherwise, +returns False. + + + +RELATED +&cdeman.XmDragContext; and +&cdeman.XmDropSite;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Text.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Text.sgm new file mode 100644 index 00000000..ac4099cb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Text.sgm @@ -0,0 +1,4453 @@ + + + + + + + + + + +XmText +library call + + +XmText +The Text widget class + +XmText + +widget class +Text + + + +#include <Xm/Text.h> + + + +DESCRIPTION +Text provides a single-line and multiline text editor for customizing both user and +programmatic interfaces. It can be used for single-line string entry, +forms entry with verification procedures, and full-window editing. +It provides an application with a consistent editing system for +textual data. The screen's textual data adjusts to the +application writer's needs. + +Text provides separate callback lists to verify +movement of the insert cursor, modification of the text, and +changes in input focus. Each of +these callbacks provides the verification function with the +widget instance, the event that caused the callback, and a +data structure specific to the verification type. From this +information, the function can verify if the application considers +this to be a legitimate state change and can signal the widget +whether to continue with the action. + +The user interface tailors a new set of translations. The default +translations provide key bindings for insert cursor movement, deletion, +insertion, and selection of text. + +Text allows the user to select regions of text. +Selection is based on the model specified in the Inter-Client +Communication Conventions Manual (ICCCM). Text supports primary +and secondary selection. + + +In some Asian languages, texts are drawn vertically. Also, some characters +are displayed with 90-degree clockwise rotation, and other characters are mapped +to vertical glyphs that differ from the normal horizaontal +glyphs. +XNOrientation XOC values.]]> +XmText widget should also handle the vertically aligned +lines as for editing, entering, or selecting texts. + +The vertical writing feature of the XmText widget is enabled when the +XmTOP_TO_BOTTOM value is specified for the XmNlayoutDirection +resource of the XmText widget. In that case, the horizontal scroll +bar is displayed on the bottom of the XmText widget and the vertical +scroll bar is displayed on the left side. + + + +Mouse Selection +The Text widget allows text to be edited, inserted, and selected. +The user can cut, copy, and paste text by using the clipboard, primary +transfer, or secondary transfer. +Text also provides a Drag and Drop facility that enables the user to +copy or move data within Text or to a different widget. +When +keyboard focus policy is set to EXPLICIT, the widget that receives +focus is the destination widget. In POINTER mode, any keyboard +or mouse operation (except secondary selection) in an +editable widget establishes that widget as the destination. + +If a destination widget becomes insensitive or uneditable, it forfeits +its destination status. In EXPLICIT mode, when a widget becomes +insensitive, the focus moves to another widget. If that widget +is editable, it becomes the destination widget; otherwise, there +is no destination widget. The text of any insensitive Text widget +is stippled, indicating its state to the user. + +The insertion cursor, displayed as an I-beam, shows where input is +inserted. Input is inserted just before the insertion cursor. + +Text uses the XmQTnavigator, XmQTspecifyRenderTable, and +XmQTscrollFrame traits, +and holds the XmQTaccessTextual +and XmQTtransfer traits. +The widget checks its parent for the XmQTscrollFrame trait. If this +trait does not exist, then the widget has no scrolling. If the trait +does exist, and the ScrollFrame widget has not been initialized, the widget +creates two navigators and sets up the scrollbars. + +If an application or widget calls the setValue trait method +of XmQTaccessTextual, then XmText will call +XmTextSetString to set the string value. + + + +Classes +Text inherits behavior, resources, and traits from Core and +XmPrimitive. + +The class pointer is xmTextWidgetClass. + +The class name is XmText. + + + +Data Transfer Behavior +Text supports transfer of the primary, secondary, and clipboard +selections and dragging of selected text from the widget. +Text can also be the destination for the primary, secondary, and +clipboard selections, and it supports dropping of data being dragged +onto the widget. + +When the XmNconvertCallback procedures are called, the +location_data member of the XmConvertCallbackStruct member +is NULL if the selected text is being transferred. +If the entire text, not the selected text, is being transferred, the +value of this member is the widget ID of the Text widget. + +As a source of data, Text supports the following targets and associated +conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers the selected text in the encoding of the locale. + + + + +COMPOUND_TEXT + +The widget transfers the selected text as type COMPOUND_TEXT. + + + + +STRING + +The widget transfers the selected text as type STRING. + + + + +TEXT + +If the selected text is fully convertible to the encoding of the locale, +the widget transfers the selected text in the encoding of the locale. +Otherwise, the widget transfers the selected text as type +COMPOUND_TEXT. + + + + +DELETE + +The widget deletes the selected text. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets to which +the widget can convert data to be placed on the clipboard immediately. +If the selected text is fully convertible to STRING, these include +STRING; otherwise, they include COMPOUND_TEXT. + + + + +_MOTIF_DEFERRED_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports for delayed transfer for the CLIPBOARD selection. +This widget currently supplies no targets for +_MOTIF_DEFERRED_CLIPBOARD_TARGETS. + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +These include COMPOUND_TEXT, the encoding of the locale, +STRING, TEXT, BACKGROUND, and FOREGROUND. + + + + +_MOTIF_LOSE_SELECTION + +The widget takes the following actions: + + + +When losing the PRIMARY selection, it unhighlights the selected +text and calls the XmNlosePrimaryCallback procedures. + + + +When losing the SECONDARY selection, it removes the secondary +selection highlight. + + + +When losing the _MOTIF_DESTINATION selection, if the widget does +not have focus, it changes the cursor to indicate that the widget is no +longer the destination. + + + + + + +As a source of data, Text also supports the following standard Motif +targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +These also include COMPOUND_TEXT, the encoding of the locale, +STRING, and TEXT. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + +As a destination for data, Text chooses a target and requests conversion +of the selection to that target. +If the encoding of the locale is present in the list of available +targets, Text chooses a requested target from the available targets in +the following order of preference: + + + +The encoding of the locale + + + +TEXT + + + +COMPOUND_TEXT + + + +STRING + + + +If the encoding of the locale is not present in the list of available +targets, Text chooses a requested target from the available targets in +the following order of preference: + + + +COMPOUND_TEXT + + + +STRING + + + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + +XmText Resource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNautoShowCursorPosition +XmCAutoShowCursorPosition +Boolean +True +CSG + + +XmNcursorPosition +XmCCursorPosition +XmTextPosition +0 +CSG + + +XmNcursorPositionVisible +XmCCursorPositionVisible +Boolean +dynamic +CSG + + +XmNdestinationCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNeditable +XmCEditable +Boolean +True +CSG + + +XmNeditMode +XmCEditMode +int +XmSINGLE_LINE_EDIT +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNgainPrimaryCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlosePrimaryCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlosingFocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +5 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +5 +CSG + + +XmNmaxLength +XmCMaxLength +int +largest integer +CSG + + +XmNmodifyVerifyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmodifyVerifyCallbackWcs +XmCCallback +XtCallbackList +NULL +C + + +XmNmotionVerifyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmtotalLines +XmCTotalLines +int +dynamic +C + + +XmNsource +XmCSource +XmTextSource +Default source +CSG + + +XmNtopCharacter +XmCTopCharacter +XmTextPosition +0 +CSG + + +XmNvalue +XmCValue +String +"" +CSG + + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNvalueWcs +XmCvalueWcs +wchar_t * +(wchar_t *)"" +CSG1 + + +XmNverifyBell +XmCVerifyBell +Boolean +dynamic +CSG + + + + +1 This resource cannot be set in a resource file. + + + +XmNactivateCallback + +Specifies the list of callbacks that is called when the user invokes an +event that calls the +activate() action. +The type of the structure whose address is passed to this callback is +XmAnyCallbackStruct. +The reason sent by the callback is XmCR_ACTIVATE. + + + + +XmNautoShowCursorPosition + +Ensures that the visible text contains the insert cursor when set +to True. +If the insert cursor changes, the contents +of Text may scroll in order to bring the insertion +point into the window. +Setting this resource to False, however, does not ensure that Text +will not scroll. + + + + +XmNcursorPosition + +Indicates the position in the text where the current insert cursor is to +be located. +Position is determined by the number of characters from the beginning of +the text. +The first character position is 0 (zero). + + + + +XmNcursorPositionVisible + +If the widget has an XmPrintShell as one of its ancestors, then the +default value is False; otherwise, it is True. + + + + +XmNdestinationCallback + +Specifies a list of callbacks called when the widget is the destination +of a transfer operation. +The type of the structure whose address is passed to these callbacks is +XmDestinationCallbackStruct. +The reason is XmCR_OK. + + + + +XmNeditable + +When set to True, indicates that the user can edit the text string. +Prohibits the user from editing the text when set to False. + + +When XmNeditable is used on a widget +it sets the dropsite to XmDROP_SITE_ACTIVE. + + + + +XmNeditMode + +Specifies the set of keyboard bindings used in Text. +The default, XmSINGLE_LINE_EDIT, +provides the set of key bindings to be used in editing +single-line text. +XmMULTI_LINE_EDIT provides the set of key bindings to be +used in editing multiline text. + +The results of placing a Text widget inside a ScrolledWindow when the +Text's XmNeditMode is XmSINGLE_LINE_EDIT are undefined. + + + + +XmNfocusCallback + +Specifies the list of callbacks called +when Text accepts input focus. The type of the structure whose +address is passed to this callback is XmAnyCallbackStruct. +The reason sent by the callback is XmCR_FOCUS. + + + + +XmNgainPrimaryCallback + +Specifies the list of callbacks called when an event causes the Text +widget to gain ownership of the primary selection. +The reason sent by the callback is XmCR_GAIN_PRIMARY. + + + + +XmNlosePrimaryCallback + +Specifies the list of callbacks called when an event causes the Text +widget to lose ownership of the primary selection. +The reason sent by the callback is XmCR_LOSE_PRIMARY. + + + + +XmNlosingFocusCallback + +Specifies the list of callbacks called +before Text loses input focus. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_LOSING_FOCUS. + + + + +XmNmarginHeight + +Specifies the distance between the top edge of the widget +window and the text, and between the bottom edge of the widget +window and the text. + + + + +XmNmarginWidth + +Specifies the distance between the left edge of the widget +window and the text, and between the right edge of the widget +window and the text. + + + + +XmNmaxLength + +Specifies the maximum length of the text string that can be entered into +text from the keyboard. This value must be nonnegative. +Strings that are entered by using the XmNvalue resource or the +XmTextSetString function ignore this resource. + + + + +XmNmodifyVerifyCallback + +Specifies the list of callbacks called +before text is deleted from or inserted into Text. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_MODIFYING_TEXT_VALUE. +When multiple Text widgets share the same +source, only the widget that initiates the source change will +generate XmNmodifyVerifyCallback. + +If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs +are registered callback lists, the procedure(s) in the +XmNmodifyVerifyCallback list is always executed first; and the +resulting data, which may have been modified, is passed to the +XmNmodifyVerifyCallbackWcs callback routines. + + + + +XmNmodifyVerifyCallbackWcs + +Specifies the list of callbacks called before text is deleted from +or inserted into Text. The type of the structure whose address is +passed to this callback is XmTextVerifyCallbackStructWcs. The +reason sent by the callback is XmCR_MODIFYING_TEXT_VALUE. +When multiple Text widgets share the same +source, only the widget that initiates the source change will +generate the XmNmodifyVerifyCallbackWcs. + +If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs +are registered callback lists, the procedure(s) in the +XmNmodifyVerifyCallback list is always executed first; and the +resulting data, which may have been modified, is passed to the +XmNmodifyVerifyCallbackWcs callback routines. + + + + +XmNmotionVerifyCallback + +Specifies the list of callbacks called +before the insert cursor is moved to a new position. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_MOVING_INSERT_CURSOR. +It is possible for more than one XmNmotionVerifyCallback to +be generated from a single action. + + + + +XmNsource + +Specifies the source with which the widget displays text. +If no source is specified, the widget creates a default string source. +This resource can be used to share text sources between Text widgets. + + + + +XmNtopCharacter + +Displays the position of text at the top of the window. +Position is determined by the number of characters from the +beginning of the text. +The first character position is 0 (zero). + +If the XmNeditMode is XmMULTI_LINE_EDIT, the line of text +that contains the top character is displayed at the top of the widget +without shifting the text left or right. +XtGetValues for XmNtopCharacter returns the position of the +first character in the line that is displayed at the top of the widget. + + + + +XmNtotalLines + +Indicates the number of lines in the text widget buffer (not necessarily +visible). The initial value 1 means the text buffer is empty. The number +of lines reported takes into account the wordWrap policy +(that is, it's not simply the number of newline characters. + + + + +XmNvalue + +Specifies the string value of the Text widget as a char* +data value. +Moves the cursor to position 0 unless a value of +XmNcursorPosition was explicitly supplied in the argument list. +If XmNvalue and XmNvalueWcs are both +defined, the value of XmNvalueWcs supersedes that of +XmNvalue. XtGetValues returns a copy of the value of +the internal buffer and XtSetValues copies the string values +into the internal buffer. + + + + +XmNvalueChangedCallback + +Specifies the list of callbacks called +after text is deleted from or inserted into +Text. +The type of the structure whose address is passed to this callback is +XmAnyCallbackStruct. +The reason sent by the callback is XmCR_VALUE_CHANGED. +When multiple Text widgets share the same +source, only the widget that initiates the source change will +generate the XmNvalueChangedCallback. This callback represents a +change in the source in the Text, not in the Text +widget. The XmNvalueChangedCallback should occur only in pairs +with an XmNmodifyVerifyCallback, assuming that the doit +flag in the callback structure of the XmNmodifyVerifyCallback is +not set to False. + + + + +XmNvalueWcs + +Specifies the string value of the Text widget as a wchar_t* data +value. +Moves the cursor to position 0 unless a value of +XmNcursorPosition was explicitly supplied in the argument list. + +This resource cannot be specified in a resource file. + +If XmNvalue and XmNvalueWcs are both defined, +the value of XmNvalueWcs supersedes that of XmNvalue. +XtGetValues returns a copy of the value of the internal buffer +encoded as a wide character string. XtSetValues copies the +value of the wide character string into the internal buffer. + + + + +XmNverifyBell + +Specifies whether the bell should sound when the verification returns +without continuing the action. +The default depends on the value of the ancestor VendorShell's +XmNaudibleWarning resource. + + + + + + + + + + + + + +XmText Input Resource Set + + +Name +Class +Type +Default +Access + + +XmNpendingDelete +XmCPendingDelete +Boolean +True +CSG + + +XmNselectionArray +XmCSelectionArray +XtPointer +default array +CSG + + +XmNselectionArrayCount +XmCSelectionArrayCount +int +4 +CSG + + +XmNselectThreshold +XmCSelectThreshold +int +5 +CSG + + + + + + +XmNpendingDelete + +Indicates that pending delete mode is on when the Boolean value is True. +Pending deletion is defined as deletion +of the selected text when an insertion is made. + + + + +XmNselectionArray + +Defines the actions for multiple mouse clicks. The value of the +resource is an array of XmTextScanType elements. +XmTextScanType is an enumeration indicating possible actions. +Each mouse click performed within some time of the previous mouse +click increments the index into this array and performs the defined +action for that index. (This "multiclick" time is specified by the +operating environment, and varies among different systems. In general, +it is usually set to some fraction of a second.) The possible actions +in the order they occur in the default array are as follows: + + + +XmSELECT_POSITION, which +resets the insert cursor position. + + + +XmSELECT_WORD, which +selects a word. + + + +XmSELECT_LINE, which +selects a line of text. This action sees a line as delimited by +hard newline characters. In other words, if the word wrap +feature is on (XmNwordWrap is True), this will ignore the +newlines automatically inserted by the widget. This is the default. + + + +XmSELECT_OUT_LINE, which +selects a line of text. This action sees a line as delimited by +hard or soft newline characters. In other words, if the +word wrap feature is on (XmNwordWrap is True), the newlines +automatically inserted by the widget will be treated as delimiting +lines. + + + +XmSELECT_ALL, which +selects all of the text. + + + + + + +XmNselectionArrayCount + +Indicates the number of elements in the XmNselectionArray resource. +The value must not be negative. + + + + +XmNselectThreshold + +Specifies the number of pixels of motion that is required to select the +next character when selection is performed using the click-drag +mode of selection. +The value must not be negative. +This resource also specifies whether a drag should be started and the +number of pixels to start a drag when +Btn2Down and Btn1Down are integrated. + + + + + + + + + + + + + +XmText Output Resource Set + + +Name +Class +Type +Default +Access + + +XmNblinkRate +XmCBlinkRate +int +500 +CSG + + +XmNcolumns +XmCColumns +short +dynamic +CSG + + +XmNcursorPositionVisible +XmCCursorPositionVisible +Boolean +True +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNresizeHeight +XmCResizeHeight +Boolean +False +CSG + + +XmNresizeWidth +XmCResizeWidth +Boolean +False +CSG + + +XmNrows +XmCRows +short +dynamic +CSG + + +XmNwordWrap +XmCWordWrap +Boolean +False +CSG + + + + + + +XmNblinkRate + +Specifies the blink rate of the text cursor in milliseconds. +The time indicated in the blink rate relates to the +time the cursor is visible and the time the +cursor is invisible (that is, the time it takes to blink +the insertion cursor on and off is twice the blink +rate). The cursor does not blink when the blink rate +is set to 0 (zero). +The value must not be negative. + + + + +XmNcolumns + +Specifies the initial width of the text window as an integer number of +characters. The width equals the number of characters specified by +this resource multiplied by the width as derived from the specified +font. If the em-space +value is available, +it is used. If not, the width of the numeral "0" is used. If this is +not available, the maximum width is used. +For proportionate fonts, the actual number of characters that fit +on a given line may be greater than the value specified. +The value must be greater than 0 (zero). The default value depends +on the value of the XmNwidth resource. +If no width is specified the default is 20. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, and if the XmText +widget resource XmNeditMode is XmSINGLE_LINE_EDIT, this attribute is +ignored. If no width is specified, the default is 1. + + + + +XmNcursorPositionVisible + +Indicates that the insert cursor position is marked by a text +cursor when the Boolean value is True. + + + + +XmNfontList + +Specifies the font list to be used for Text. The font list is an +obsolete structure and is retained only for compatibility with +earlier releases of Motif. Use the render table (XmNrenderTable) +instead of font lists wherever possible. If both are specified, the +render table will take precedence. If this value is NULL at +initialization, the parent hierarchy of the widget is searched for an +ancestor that holds the XmQTspecifyRenderTable trait. If such +an ancestor is found, the font list is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such +ancestor is found, the default is implementation dependent. + +Text searches the font list for the first occurrence of a font set +that has XmFONTLIST_DEFAULT_TAG. If a default element is +not found, the first font set in the font list is used. If the +list contains no font sets, the first font in the font list will +be used. Refer to &cdeman.XmFontList; for +more information on a font list structure. + + + + +XmNrenderTable + +Specifies the render table to be used in deriving a font set or font +for rendering text. If both a render table and a font list are +specified, the render table will take precedence. If the value of +XmNrenderTable is NULL at initialization, the parent hierarchy +of the widget is searched for an ancestor that holds the +XmQTspecifyRenderTable trait. If such an ancestor is found, the +font list is initialized to the XmTEXT_RENDER_TABLE value of the +ancestor widget. If no such ancestor is found, the default is +implementation dependent. + +Text searches the render table for the first occurrence of a rendition +that has the tag _MOTIF_DEFAULT_LOCALE. If a default element is +not found, the first rendition in the table is used. Refer to +&cdeman.XmRenderTable; for more information on the render table +structure. + + + + +XmNresizeHeight + +Indicates that Text will +attempt to resize its height to accommodate all the text +contained in the widget when the Boolean value is True. If the Boolean value is set to True, +the text is always +displayed, starting from the first position in the source, even if +instructed otherwise. This attribute is ignored when the application uses a +Text widget whose parent is a ScrolledWindow and when XmNscrollVertical is True. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this resource +indicates that the text attempts to resize its height to accommodate all the +text contained in the widget when the Boolean value is True. This attribute +is ignored if XmNwordWrap is True. + + + + +XmNresizeWidth + +Indicates that Text attempts to resize its width to accommodate all +the text contained in the widget when the Boolean value is True. +This attribute is ignored if +XmNwordWrap is True. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this attribute +is still effective even if XmNwordWrap is True. +Also, this attribute is ignored when the application uses a text widget whose parent is +a ScrolledWindow and XmNscrollHorizaontal is True. + + + + +XmNrows + +Specifies the initial height of the text window measured in character +heights. This attribute is ignored if the text widget resource +XmNeditMode is XmSINGLE_LINE_EDIT. +The value must be greater than 0 (zero). +The default value depends on the value of the XmNheight resource. +If no height is specified, the default is 1. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this +attribute is still effective, even if the XmText widget resource +XmNeditMode is XmSINGLE_LINE_EDIT. If no height is specified, +the default is 20. + + + + +XmNwordWrap + +Indicates that lines are to be broken at word breaks (that is, the text +does not go off the right edge of the window) when the Boolean value is True. +Words are defined as a sequence +of characters separated +by whitespace. Whitespace is defined as +a space, tab, or newline. This attribute is ignored if the text +widget resource XmNeditMode is XmSINGLE_LINE_EDIT. +Note that this resource is only valid when the widget is not a +scroll one, or, if the widget is a scroll widget, that the +XmNscrollHorizontal resource is False. + +Indicates that lines are to be broken at word breaks (that is, +when the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, the text does not +go off the bottom edge of the window) when the Boolean value is True. + + + + +The following resources are used only when text is created in a +ScrolledWindow. See the reference page for XmCreateScrolledText. + + + + + + + + + + +XmText Scrolling Resource Set + + +Name +Class +Type +Default +Access + + +XmNscrollHorizontal +XmCScroll +Boolean +True +CG + + +XmNscrollLeftSide +XmCScrollSide +Boolean +False +CG + + +XmNscrollTopSide +XmCScrollSide +Boolean +False +CG + + +XmNscrollVertical +XmCScroll +Boolean +True +CG + + + + +Note in connection with this table that if the XmNlayoutDirection resource +is XmTOP_TO_BOTTOM, the default is True. + + + +XmNscrollHorizontal + +Adds a ScrollBar that allows the user to scroll horizontally through +text when the Boolean value is True. +This resource is forced to False when the Text widget is placed in +a ScrolledWindow with XmNscrollingPolicy set to +XmAUTOMATIC. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this +attribute is ignored if the XmText widget resource XmNeditMode +is XmSINGLE_LINE_EDIT. + + + + +XmNscrollLeftSide + +Indicates that the vertical ScrollBar should be placed on the left side of +the scrolled text window when the Boolean value is True. This attribute +is ignored if XmNscrollVertical is False or the Text resource +XmNeditMode is XmSINGLE_LINE_EDIT. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this +resource is still effective, even if the XmText widget resource +XmNeditMode is XmSINGLE_LINE_EDIT. + + + + +XmNscrollTopSide + +Indicates that the horizontal ScrollBar should be placed on the top side of the +scrolled text window when the Boolean value is True. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this +attribute is ignored if XmNscrollHorizontal is False +or the Xmtext resource +XmNeditMode is XmSINGLE_LINE_EDIT. + + + + +XmNscrollVertical + +Adds a ScrollBar that allows the user to scroll vertically through text when +the Boolean value is True. +This attribute is ignored if the Text resource XmNeditMode is +XmSINGLE_LINE_EDIT. +This resource is forced to False when the Text widget is placed in +a ScrolledWindow with XmNscrollingPolicy set to +XmAUTOMATIC. + +When the XmNlayoutDirection resource is XmTOP_TO_BOTTOM, this +resource is still effective, even if the XmText +widget resource XmNeditMode +is XmSINGLE_LINE_EDIT. + + + + + + +Inherited Resources +Text inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +The Text widget defines a new callback structure +for use with verification callbacks. Note that +not all fields are relevant for every +callback reason. The application must first +look at the reason field and use only the structure +members that are valid for the particular reason. +The values startPos, endPos, and text in the +callback structure XmTextVerifyCallbackStruct may be modified +when the callback is received, and these changes will be reflected as +changes made to the source of the Text widget. (For example, all +keystrokes can be converted to spaces or NULL characters when a +password is entered into a Text widget.) The application +programmer should not overwrite the text field, but should +attach data to that pointer. + +A pointer to the following structure is passed to callbacks for +XmNlosingFocusCallback, XmNmodifyVerifyCallback, and +XmNmotionVerifyCallback: + +typedef struct +{ + int reason; + XEvent * event; + Boolean doit; + XmTextPosition currInsert, newInsert; + XmTextPosition startPos, endPos; + XmTextBlock text; +} XmTextVerifyCallbackStruct, *XmTextVerifyPtr; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. For example, changes made to the Text widget +programmatically do not have an event that can be +passed to the associated callback. + + + + +doit + +Indicates whether the action that invoked the callback is performed. +Setting doit to False negates the action. +Note that not all actions may be negated. For example, +XmCR_LOSING_FOCUS callbacks may be beyond the control of the +widget if they are produced by mouse clicks. + + + + +currInsert + +Indicates the current position of the insert cursor. + + + + +newInsert + +Indicates the position at which the user attempts to position the insert +cursor. + + + + +startPos + +Indicates the starting position of the text to modify. If the callback is +not a modify verification callback, this value is the same as currInsert. + + + + +endPos + +Indicates the ending position of the text to modify. If no text is replaced or +deleted, the value is the same as startPos. If the callback is not +a modify verification callback, this value is the same as currInsert. + + + + +text + +Points to a structure of type XmTextBlockRec. This structure holds +the textual information to be inserted. + +typedef struct +{ + char *ptr; + int length; + XmTextFormat format; +} XmTextBlockRec, *XmTextBlock; + + +ptr + +Points to the text to be inserted. + + + + +length + +Specifies the length of the text to be inserted. + + + + +format + +Specifies the format of the text, +either XmFMT_8_BIT or XmFMT_16_BIT. + + + + + + + +A pointer to the following structure is passed to callbacks +for XmNmodifyVerifyCallbackWcs. + +typedef struct +{ + int reason; + XEvent *event; + Boolean doit; + XmTextPosition currInsert, newInsert; + XmTextPosition startPos, endPos; + XmTextBlockWcs text; +} XmTextVerifyCallbackStructWcs, *XmTextVerifyPtrWcs; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. For example, changes made to the Text widget +programmatically do not have an event that can be +passed to the associated callback. + + + + +doit + +Indicates whether the action that invoked the callback is performed. +Setting doit to False negates the action. +Note that not all actions may be negated. For example, +XmCR_LOSING_FOCUS callbacks may be beyond the control of the +widget if they are produced by mouse clicks. + + + + +currInsert + +Indicates the current position of the insert cursor. + + + + +newInsert + +Indicates the position at which the user attempts to position the insert +cursor. + + + + +startPos + +Indicates the starting position of the text to modify. If the callback is +not a modify verification callback, this value is the same as currInsert. + + + + +endPos + +Indicates the ending position of the text to modify. If no text is replaced or +deleted, the value is the same as startPos. If the callback is not +a modify verification callback, this value is the same as currInsert. + + + + +text + +Points to the following +structure of type XmTextBlockRecWcs. This structure holds +the textual information to be inserted. + +typedef struct +{ + wchar_t *wcsptr; + int length; +} XmTextBlockRecWcs, *XmTextBlockWcs; + + +wcsptr + +Points to the wide character text to be inserted. + + + + +length + +Specifies the number of characters to be inserted. + + + + + + + +The following table describes the reasons for which the individual +verification callback structure fields are valid. Note that the +event field will never be valid for XmCR_MOVING_INSERT_CURSOR. + + + + + + + +Reason +Valid Fields + + +XmCR_LOSING_FOCUS +reason, event, doit, currInsert, newInsert, startPos, endPos + + +XmCR_MODIFYING_TEXT_VALUE +reason, event, doit, currInsert, newInsert, startPos, endPos, text + + +XmCR_MOVING_INSERT_CURSOR +reason, doit, currInsert, newInsert + + + + +A pointer to the following callback structure is passed to the +XmNdestinationCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + XtEnum operation; + int flags; + XtPointer transfer_id; + XtPointer destination_data; + XtPointer location_data; + Time time; +} XmDestinationCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which data transfer is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, and +_MOTIF_DROP. + + + + +operation + +Indicates the type of transfer operation requested. + + + +When the selection is PRIMARY or SECONDARY, possible +values are XmMOVE, +XmCOPY, and XmLINK. + + + +When the selection is CLIPBOARD, possible +values are XmCOPY and XmLINK. + + + +When the selection is _MOTIF_DROP, possible values are +XmMOVE, XmCOPY, XmLINK, and XmOTHER. +A value of XmOTHER means that the callback procedure must get +further information from the XmDropProcCallbackStruct structure in the +destination_data member. + + + + + + +flags + +Indicates whether or not the destination widget is also the source of +the data to be transferred. +Following are the possible values: + + + +XmCONVERTING_NONE + +The destination widget is not the source of the data to be transferred. + + + + +XmCONVERTING_SAME + +The destination widget is the source of the data to be transferred. + + + + + + + +transfer_id + +Serves as a unique ID to identify the transfer transaction. + + + + +destination_data + +Contains information about the destination. +When the selection is _MOTIF_DROP, the callback procedures are +called by the drop site's XmNdropProc, and destination_data +is a pointer to the XmDropProcCallbackStruct structure passed to the +XmNdropProc procedure. +When the selection is SECONDARY, +destination_data +is an Atom +representing a target recommmended by the selection owner for use in +converting the selection. +Otherwise, destination_data is NULL. + + + + +location_data + +Contains information about the location where data is to be transferred. +The value is always NULL when the selection is CLIPBOARD. +If the value is NULL, the data is to be inserted at the widget's cursor +position. +Otherwise, the value is a pointer to an XPoint structure +containing the x- and y- coordinates at the location where the data is to +be transferred. Once XmTransferDone procedures start to be called, +location_data will no longer be stable. + + + + +time + +Indicates the time when the transfer operation began. + + + + + + +Translations +The XmText translations are described in the following list. +The actions represent the effective behavior of the associated events, +and they may differ in a right-to-left language environment. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +≈c s ≈m ≈a Btn1Down: + +extend-start() + + + + +c ≈s ≈m ≈a Btn1Down: + +move-destination() + + + + +≈c ≈s ≈m ≈a Btn1Down: + +grab-focus() + + + + +≈c ≈m ≈a Btn1Motion: + +extend-adjust() + + + + +≈c ≈m ≈a Btn1Up: + +extend-end() + + + + +Btn2Down: + +process-bdrag() + + + + +m ≈a Btn2Motion: + +secondary-adjust() + + + + +≈m a Btn2Motion: + +secondary-adjust() + + + + +s c <Btn2Up>: + +link-to() + + + + +≈s Btn2Up: + +copy-to() + + + + +≈c Btn2Up: + +move-to() + + + + +:m KeyosfPrimaryPaste: + +cut-primary() + + + + +:a KeyosfPrimaryPaste: + +cut-primary() + + + + +:KeyosfPrimaryPaste: + +copy-primary() + + + + +:m KeyosfCut: + +cut-primary() + + + + +:a KeyosfCut: + +cut-primary() + + + + +:KeyosfCut: + +cut-clipboard() + + + + +:KeyosfPaste: + +paste-clipboard() + + + + +:m KeyosfCopy: + +copy-primary() + + + + +:a KeyosfCopy: + +copy-primary() + + + + +:KeyosfCopy: + +copy-clipboard() + + + + +:s c KeyosfBeginLine: + +beginning-of-file(extend) + + + + +:c KeyosfBeginLine: + +beginning-of-file() + + + + +:s KeyosfBeginLine: + +beginning-of-line(extend) + + + + +:KeyosfBeginLine: + +beginning-of-line() + + + + +:s c KeyosfEndLine: + +end-of-file(extend) + + + + +:c KeyosfEndLine: + +end-of-file() + + + + +:s KeyosfEndLine: + +end-of-line(extend) + + + + +:KeyosfEndLine: + +end-of-line() + + + + +:s KeyosfPageLeft: + +page-left(extend) (ignored in vertical +writing) + + + + +:KeyosfPageLeft: + +page-left() (next-page() in vertical writing) + + + + +:s c KeyosfPageUp: + +page-left(extend) + + + + +:c KeyosfPageUp: + +page-left() + + + + +:s KeyosfPageUp: + +previous-page(extend) (ignored +in vertical writing) + + + + +:KeyosfPageUp: + +previous-page() (page-up() in vertical writing) + + + + +:s KeyosfPageRight: + +page-right(extend) (ignored +in vertical writing) + + + + +:KeyosfPageRight: + +page-right() (previous-page() in vertical +writing) + + + + +s c KeyosfPageDown: + +page-right(extend) (ignored +in vertical writing) + + + + +:c KeyosfPageDown: + +page-right() + + + + +:s KeyosfPageDown: + +next-page(extend) (ignored in vertical +writing) + + + + +:KeyosfPageDown: + +next-page() (page-down() in vertical writing) + + + + +:KeyosfClear: + +clear-selection() + + + + +:KeyosfBackSpace: + +delete-previous-character() + + + + +:s m KeyosfDelete: + +cut-primary() + + + + +:s a KeyosfDelete: + +cut-primary() + + + + +:s KeyosfDelete: + +cut-clipboard() + + + + +:c KeyosfDelete: + +delete-to-end-of-line() + + + + +:KeyosfDelete: + +delete-next-character() + + + + +:c m KeyosfInsert: + +copy-primary() + + + + +:c a KeyosfInsert: + +copy-primary() + + + + +:s KeyosfInsert: + +paste-clipboard() + + + + +:c KeyosfInsert: + +copy-clipboard() + + + + +:s KeyosfSelect: + +key-select() + + + + +:KeyosfSelect: + +set-anchor() + + + + +:KeyosfSelectAll: + +select-all() + + + + +:KeyosfDeselectAll: + +deselect-all() + + + + +:KeyosfActivate: + +activate() + + + + +:KeyosfAddMode: + +toggle-add-mode() + + + + +:KeyosfHelp: + +Help() + + + + +:KeyosfCancel: + +process-cancel() + + + + +:s c KeyosfLeft: + +backward-word(extend) ( +forward-paragraph(extend) in +vertical writing) + + + + +:c KeyosfLeft: + +backward-word() (forward-paragraph() in vertical writing) + + + + +:s KeyosfLeft: + +key-select(left) +(process-shift-left() in vertical writing) + + + + +:KeyosfLeft: + +backward-character() (process-left() +in vertical writing) + + + + +:s c KeyosfRight: + +forward-word(extend) +(backward-paragraph(extend) +in vertical writing) + + + + +:c KeyosfRight: + +forward-word() (backward-paragraph() +in vertical writing) + + + + +:s KeyosfRight: + +key-select(right) +(process-shift-right in vertical writing) + + + + +:KeyosfRight: + +forward-character() (process-right() +in vertical writing) + + + + +:s c KeyosfUp: + +backward-paragraph(extend) +(backward-word(extend) +in vertical writing) + + + + +:c KeyosfUp: + +backward-paragraph() (backward-word() +in vertical writing) + + + + +:s KeyosfUp: + +process-shift-up() +(key-select(up) +in vertical writing) + + + + +:KeyosfUp: + +process-up() (backward-character() +in vertical writing) + + + + +:s c KeyosfDown: + +forward-paragraph(extend) +(forward-word(extend) +in vertical writing) + + + + +:c KeyosfDown: + +forward-paragraph() (forward-word() +in vertical writing) + + + + +:s KeyosfDown: + +process-shift-down() +(key-select(down) +in vertical writing) + + + + +:KeyosfDown: + +process-down() (forward-character() +in vertical writing) + + + + +c ≈m ≈a Keyslash: + +select-all() + + + + +c ≈m ≈a Keybackslash: + +deselect-all() + + + + +s c ≈m ≈a KeyTab: + +prev-tab-group() + + + + +≈s c ≈m ≈a KeyTab: + +next-tab-group() + + + + +s ≈c ≈m ≈a KeyTab: + +process-tab(Prev) + + + + +≈s ≈c ≈m ≈a KeyTab: + +process-tab(Next) + + + + +≈s c ≈m ≈a KeyReturn: + +activate() + + + + +≈s ≈c ≈m ≈a KeyReturn: + +process-return() + + + + +≈s c ≈m ≈a Keyspace: + +set-anchor() + + + + +s c ≈m ≈a Keyspace: + +key-select() + + + + +s ≈c ≈m ≈a Keyspace: + +self-insert() + + + + +Key: + +self-insert() + + + + +The Text button event translations are modified when Display's +XmNenableBtn1Transfer resource does not have a value of +XmOFF (in other words, it is either XmBUTTON2_TRANSFER or +XmBUTTON2_ADJUST). This +option allows the +actions for selection and transfer to be integrated on Btn1, and +the actions for extending the selection can be bound to +Btn2. The actions for Btn1 that are defined above +still apply when the Btn1 event occurs over text that is not +selected. The following actions apply when the Btn1 event +occurs over text that is selected: + + + +Btn1Down: + +process-bdrag(). + + + + +ShiftBtn1Down: + +process-bdrag(). + + + + +CtrlBtn1Down: + +process-bdrag(). + + + + +Btn1DownShiftBtn1Up: + +grab-focus(), extend-end. + + + + +ShiftBtn1DownShiftBtn1Up: + +extend-start(), extend-end(). + + + + +CtrlBtn1DownShiftBtn1Up: + +move-destination(). + + + + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the following actions apply: + + + +Btn2Down: + +extend-start(). + + + + +Btn2Motion: + +extend-adjust(). + + + + +Btn2Up: + +extend-end(). + + + + + + +Action Routines +The XmText action routines are + + + +activate(): + +Calls the callbacks for XmNactivateCallback. +Passes the event to the parent. + + + + +backward-character(extend): + +Moves the insertion cursor one character to the left. +This action may have different behavior in a right-to-left language +environment. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The backward-character() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +backward-character() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In vertical writing, if XmNeditMode is XmSINGLE_LINE_EDIT and +XmNnavigationType +is XmNONE, traverses to the widget to the left in the tab +group. If XmNeditMode is XmMULTI_LINE_EDIT, moves the insertion cursor +to the next line in the same column. + + + + +backward-paragraph(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with no argument, +moves the insertion cursor to the first non-whitespace character following +the first previous blank line or beginning of the text. +If the insertion cursor is already at the beginning of a paragraph, +moves the insertion cursor to the beginning of the previous paragraph. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The backward-paragraph() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +backward-paragraph() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +backward-word(extend): + +If this action is called with no argument, +moves the insertion cursor to the first non-whitespace character after the +first whitespace character to the left or after the beginning of the line. +If the insertion cursor is already at the beginning of a word, +moves the insertion cursor to the beginning of the previous word. +This action may have different behavior in a locale other than the C locale. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The backward-word() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +backward-word() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +beep(): + +Causes the terminal to beep. +The beep() action produces no callbacks. + + + + +beginning-of-file(extend): + +If this action is called with no argument, +moves the insertion cursor to the beginning of the text. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The beginning-of-file() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +beginning-of-file() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +beginning-of-line(extend): + +If this action is called with no argument, +moves the insertion cursor to the beginning of the line. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The beginning-of-line() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +beginning-of-line() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +clear-selection(): + +Clears the current selection by replacing each character except +Return with a space character. + +The clear-selection() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +copy-clipboard(): + +If this widget owns the primary selection, this action copies the +selection to the clipboard. +This action calls the XmNconvertCallback procedures, possibly +multiple times, for the CLIPBOARD selection. + + + + +copy-primary(): + +Copies the primary selection to just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmCOPY operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. + +In addition, the copy-primary() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, to the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +copy-to(): + +If a secondary selection exists, this action copies the secondary +selection to the insertion position of the destination component. +If the primary selection is in the destination widget, it will +be deselected. Otherwise, there is no effect on the primary selection. + +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmCOPY operation. +The destination's XmNdestinationCallback procedures or the +destination component itself invokes the selection owner's +XmNconvertCallback procedures, possibly multiple times, for the +SECONDARY selection. + +If no secondary selection exists, this action copies the primary +selection to the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmCOPY operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. + +In addition, the copy-to() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, to the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If there is no secondary selection, the +copy-to() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +cut-clipboard(): + +If this widget owns the primary selection, this action cuts the +selection to the clipboard. +This action calls the XmNconvertCallback procedures, possibly +multiple times, for the CLIPBOARD selection. +If the transfer is successful, this action then calls the +XmNconvertCallback procedures for the CLIPBOARD selection +and the DELETE target. + +In addition, the cut-clipboard() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +cut-primary(): + +Cuts the primary selection and pastes it just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmMOVE operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the PRIMARY +selection and the DELETE target. +The cut-primary() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In addition, the cut-primary() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR, the XmNmodifyVerifyCallback +procedures with reason value XmCR_MODIFYING_TEXT_VALUE, and the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED. + + + + +delete-next-character(): + +In normal mode, if there is a nonnull selection, deletes the selection; +otherwise, +deletes the character following the insertion cursor. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the character following the insertion cursor. +This may impact the selection. + +The delete-next-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-next-word(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next space, tab +or end-of-line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next space, tab +or end-of-line character. +This may impact the selection. +This action may have different behavior in a locale other than the C +locale. + +The delete-next-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-previous-character(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the character of text immediately preceding the insertion cursor. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the character of text immediately preceding the insertion cursor. +This may impact the selection. + +The delete-previous-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +delete-previous-word(): + +In normal mode, if there is a nonnull selection, deletes the +selection; otherwise, deletes the characters preceding the insertion +cursor to the next space, tab or beginning-of-line character. In add +mode, if there is a nonnull selection, the cursor is not disjoint from +the selection, and XmNpendingDelete is set to True, deletes the +selection; otherwise, deletes the characters preceding the insertion +cursor to the next space, tab or beginning-of-line character. This +may impact the selection. This action may have different behavior in +a locale other than the C locale. + +The delete-previous-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +delete-selection(): + +Deletes the current selection. + +The delete-selection() action +produces calls to the XmNmodifyVerifyCallback procedures with +reason value XmCR_MODIFYING_TEXT_VALUE, the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED, and the XmNmotionVerifyCallback +procedures with reason value XmCR_MOVING_INSERT_CURSOR. + + + + +delete-to-end-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next end of +line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next end +of line character. +This may impact the selection. + +The delete-to-end-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-to-start-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters preceding the insertion cursor to the previous +beginning-of-line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters preceding the insertion cursor +to the previous beginning-of-line character. +This may impact the selection. + +The delete-to-start-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +deselect-all(): + +Deselects the current selection. +The deselect-all() action +produces no callbacks. + + + + + + + + + + +end-of-file(extend): + +If this action is called with no argument, +moves the insertion cursor to the end of the text. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The end-of-file() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +end-of-file() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +end-of-line(extend): + +If this action is called with no argument, +moves the insertion cursor to the end of the line. +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The end-of-line() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +end-of-line() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-adjust(): + +Selects text from the anchor to the pointer position and deselects text +outside that range. +Moving the pointer over several lines selects text from the anchor to +the end of each line the pointer moves over and up to the pointer +position on the current line. + +The extend-adjust() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The extend-adjust() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-end(): + +Moves the insertion cursor to the position of the pointer. +The extend-end() action is used to commit the selection. After +this action has been done, process-cancel() will no longer +cancel the selection. + +The extend-end() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The extend-end() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-start(): + +Adjusts the anchor using the balance-beam method. +Selects text from the anchor to the pointer position and deselects text +outside that range. +The extend-start() action may produce no callbacks, +however, the extend-start() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +forward-character(extend): + +Moves the insertion cursor one character to the right. +This action may have different behavior in a right-to-left language +environment. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The forward-character() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +forward-character() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In vertical writing, if XmNeditMode is XmSINGLE_LINE_EDIT and +XmNnavigationType is XmNONE, traverses to the widget to +the right in the tab group. If XmNeditMode is XmMULTI_LINE_EDIT, +moves the insertion cursor to the previous line in the same column. + + + + +forward-paragraph(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT, +and this action is called with no argument, +moves the insertion cursor to the first non-whitespace character +following the next blank line. +If the insertion cursor is already at the beginning of a paragraph, +moves the insertion cursor to the beginning of the next paragraph. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The forward-paragraph() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +forward-paragraph() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +forward-word(extend): + +If this action is called with no argument, moves the insertion cursor to +the first whitespace character or end-of-line following the next +non-whitespace character. +If the insertion cursor is already at the end of a word, +moves the insertion cursor to the end of the next word. +This action may have different behavior in a locale other than the C locale. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The forward-word() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +forward-word() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +grab-focus(): + +This key binding performs the action defined in the +XmNselectionArray, depending on the number of multiple mouse +clicks. +The default selection array ordering is one click to move the +insertion cursor to the pointer position, two clicks to select a word, three +clicks to select a line of text, and four clicks to select all text. +A single click also deselects any selected text and sets the anchor at +the pointer position. +This action may have different behavior in a locale other than the C locale. + +The grab-focus() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +insert-string(string): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts string before the insertion cursor. + +The insert-string() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +Note that, in the case of an empty string, no callbacks will be +called, since no modification will have been done. However, if the +insertion position is inside the current selection, +insert-string with an empty string will cause the selection to +be deselected, and the XmNmotionVerifyCallback procedures to be +called with reason value XmCR_MOVING_INSERT_CURSOR, +XmCR_MODIFYING_TEXT_VALUE, and XmCR_VALUE_CHANGED. + + + + +key-select(right|left): + +If called with an argument of right, moves the insertion cursor +one character to the right and extends the current selection. +If called with an argument of left, moves the insertion cursor +one character to the left and extends the current selection. +If called with no argument, extends the current selection. + +Note that after a key-select action, the selection will still +begin at the original anchor, and will extend to the position +indicated in the action call. If this new position is on the opposite +side of the selection anchor from the previous selection boundary, the +original selection will be deselected. + +The key-select() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The key-select() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In vertical writing, if called with the argument left, and if +XmNeditMode is XmMULTI_LINE_EDIT, moves +the insertion cursor to the next line in the same column. +In vertical writing, if called with the argument right, and if +XmNeditMode is XmMULTI_LINE_EDIT, moves +the insertion cursor to the previous line in the same column.) + + + + +kill-next-character(): + +In normal mode, if there is a nonnull selection, +kills +the selection; otherwise, +kills the character following the insertion cursor and stores the +character in the cut buffer. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +kills the character following the insertion cursor and stores the character +in the cut buffer. +This may impact the selection. + +The killed text is stored in CUT_BUFFER0. + +The kill-next-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +kill-next-word(): + +In normal mode, if there is a nonnull selection, deletes the +selection; otherwise, kills the characters following the insertion +cursor to the next space, tab or end-of-line character, and stores the +characters in the cut buffer. In add mode, if there is a nonnull +selection, the cursor is not disjoint from the selection, and +XmNpendingDelete is set to True, deletes the selection; +otherwise, kills the characters following the insertion cursor to the +next space, tab or end-of-line character, and stores the characters in +the cut buffer. This may impact the selection. This action may have +different behavior in a locale other than the C locale. + +The killed text is stored in CUT_BUFFER0. + +The kill-next-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +kill-previous-character(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +kills the character immediately preceding the insertion cursor and stores the +character in the cut buffer. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +kills the character immediately preceding the insertion cursor and stores +the character in the cut buffer. +This may impact the selection. + +The killed text is stored in CUT_BUFFER0. + +The kill-previous-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +kill-previous-word(): + +In normal mode, if there is a nonnull selection, deletes the +selection; otherwise, kills the characters preceding the insertion +cursor up to the next space, tab or beginning-of-line character, and +stores the characters in the cut buffer. In add mode, if there is a +nonnull selection, the cursor is not disjoint from the selection, and +XmNpendingDelete is set to True, deletes the selection; +otherwise, kills the characters preceding the insertion cursor up to +the next space, tab or beginning-of-line character, and stores the +characters in the cut buffer. This may impact the selection. This +action may have different behavior in a locale other than the C +locale. + +The killed text is stored in CUT_BUFFER0. + +The kill-previous-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +kill-selection(): + +Kills the currently selected text and stores the text in the cut +buffer. + +The killed text is stored in CUT_BUFFER0. + +The kill-selection() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +kill-to-end-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; +otherwise, +kills the characters following the insertion cursor to the next end-of-line +character and stores the characters in the cut buffer. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +kills the characters following the insertion cursor to the next end of +line character and stores the characters in the cut buffer. +This may impact the selection. + +The killed text is stored in CUT_BUFFER0. + +The kill-to-end-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. +In the case where there is a non-null selection to be deleted, this +action may also produce calls to the XmNmotionVerifyCallback +procedures with reason value XmCR_MOVING_INSERT_CURSOR. + + + + +kill-to-start-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +kills the characters preceding the insertion cursor to the next +beginning-of-line character and stores the characters in the cut buffer. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection, and XmNpendingDelete is set to True, +deletes the selection; otherwise, +kills the characters preceding the insertion cursor to the next +beginning-of-line character and stores the characters in the cut buffer. +This may impact the selection. + +The killed text is stored in CUT_BUFFER0. + +The kill-to-start-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +link-primary(): + +Places a link to the primary selection just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmLINK operation. +The Text widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the primary selection and for taking any related actions. + + + + +link-to(): + +If a secondary selection exists, this action places a link to the +secondary selection at the insertion position of the destination +component. +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmLINK operation. + +If no secondary selection exists, this action places a link to the +primary selection at the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmLINK operation. + +The Text widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the primary or secondary selection and for taking any +related actions. + + + + +move-destination(): + +Moves the insertion cursor to the pointer position without changing any +existing current selection. +If there is +a +current selection, sets the widget as the destination widget. +This also moves the widget focus to match the insertion cursor. + +The move-destination() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +move-to(): + +If a secondary selection exists, this action moves the secondary +selection to the insertion position of the destination component. +If the secondary selection is in the destination widget, and the +secondary selection and the primary selection overlap, the result +is undefined. +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmMOVE operation. +The destination's XmNdestinationCallback procedures or the +destination component itself invokes the selection owner's +XmNconvertCallback procedures, possibly multiple times, for the +SECONDARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the SECONDARY +selection and the DELETE target. + +If no secondary selection exists, this action moves the primary +selection to the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmMOVE operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the PRIMARY +selection and the DELETE target. + +The move-to() action produces calls to the XmNmodifyVerifyCallback +procedures with reason value XmCR_MODIFYING_TEXT_VALUE, the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED, and the XmNmotionVerifyCallback +procedures with reason value XmCR_MOVING_INSERT_CURSOR. +If there is no secondary selection, the +move-to() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +newline(): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts a newline before the insertion cursor. + +The newline() action produces calls to the XmNmodifyVerifyCallback +procedures with reason value XmCR_MODIFYING_TEXT_VALUE, the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED, and the XmNmotionVerifyCallback +procedures with reason value XmCR_MOVING_INSERT_CURSOR. + + + + +newline-and-backup(): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts a newline just before the insertion cursor and repositions the insertion cursor to the end of the +line before the newline. + +The newline-and-backup() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +newline-and-indent(): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts a newline and then the same number of whitespace characters as +at the beginning of the previous line. + +The newline-and-indent() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +next-line(): + +Moves the insertion cursor to the next line. + +The next-line() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + + + +next-page(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with no argument, +moves the insertion cursor forward one page. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, +it moves the insertion cursor as +in the case of no argument and extends the current selection. + +The next-page() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +next-page() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In vertical writing, scrolls the viewing window down one page +of text. + + + + +next-tab-group(): + +Traverses to the next tab group. + +The next-tab-group() action produces no callbacks, unless it +results in the widget losing focus, in which case, the +XmNlosingFocusCallback procedures are called with reason value +XmCR_LOSING_FOCUS. + + + + +page-left(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with no argument, +moves the insertion cursor back one page. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, +it moves the insertion cursor as +in the case of no argument and extends the current selection. + +The page-left() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +page-left() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +page-right(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with no argument, +moves the insertion cursor forward one page. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, +it moves the insertion cursor as +in the case of no argument and extends the current selection. + +The page-right() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +page-right() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +paste-clipboard(): + +Pastes the contents of the clipboard before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +CLIPBOARD selection and the XmCOPY operation. + +The paste-clipboard() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +prev-tab-group(): + +Traverses to the previous tab group. + +The prev-tab-group() action produces no callbacks, unless it +results in the widget losing focus, in which case, the +XmNlosingFocusCallback procedures are called with reason value +XmCR_LOSING_FOCUS. + + + + +previous-line(): + +Moves the insertion cursor to the previous line. + +The previous-line() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +previous-page(extend): + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with no argument, +moves the insertion cursor back one page. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, +it moves the insertion cursor as +in the case of no argument and extends the current selection. + +The previous-page() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +previous-page() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + +In vertical writing, if called without an argument, scrolls the viewing window up one page +of text. + + + + +process-bdrag() + +If the pointer is within the selection, this action starts a drag +operation for the selection. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. + +If no selection exists or the pointer is outside the selection, this +action prepares to start a secondary selection at the pointer position. + + +Note that when dragging a secondary selection to a different widget, +focus will shift momentarily to the second widget, and then back to +the original widget. This will generate callbacks to the +XmNlosingFocusCallback procedures as focus is lost (by each +widget) as well as callbacks to the XmNfocusCallback procedures +as focus is regained. + + + + + +process-cancel(): + +Cancels the current extend-adjust(), secondary-adjust() +or process-bdrag() +operation and leaves the selection state as it was before the operation; +otherwise, and if the parent is a manager, passes the event to the +parent. + + + + +process-down(extend): + +If XmNeditMode is XmSINGLE_LINE_EDIT, and +XmNnavigationType is XmNONE, +traverses to the widget below the current one in the tab group. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +In this case, the action will produce the XmNlosingFocusCallback +callbacks with reason value XmCR_LOSING_FOCUS. + +If XmNeditMode is XmMULTI_LINE_EDIT, +moves the insertion cursor down one line. + +The process-down() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + +In vertical writing, moves the insertion cursor +one character down. + + + + +process-home(): + +Moves the insertion cursor to the beginning of the line. + +The process-home() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +process-return(): + +If XmNeditMode is XmSINGLE_LINE_EDIT, +calls the callbacks for XmNactivateCallback, +and if the parent is a manager, passes the event to the parent. +If XmNeditMode is XmMULTI_LINE_EDIT, +inserts a newline. + +The process-return() action during single-line edit produces calls to the +XmNactivateCallback procedures with reason value +XmCR_ACTIVATE. During multi-line editing, the +process-return() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +process-shift-down(): + +If XmNeditMode is XmMULTI_LINE_EDIT, +moves the insertion cursor down one +line and selects. If XmNeditMode is XmSINGLE_LINE_EDIT, +this action behaves like process-up() in XmSINGLE_LINE_EDIT. +Refer to the process-up() action. + +The process-shift-down() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + +In vertical writing, if called with the argument +up, moves the insertion cursor one character +up and extends the current selection. If called with +the argument down, moves the insertion cursor +one character down and extends the current selection. + + + + +process-shift-up(): + +If XmNeditMode is XmMULTI_LINE_EDIT, +moves the insertion cursor up one +line and selects. If XmNeditMode is XmSINGLE_LINE_EDIT, +this action behaves like process-up() in XmSINGLE_LINE_EDIT. +Refer to the process-up() action. + +The process-shift-up() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + +In vertical writing, if called with the argument +up, moves the insertion cursor one character +up and extends the current selection. If called with +the argument down, moves the insertion cursor +one character down and extends the current selection. + + + + +process-tab(Prev|Next): + +If XmNeditMode is XmSINGLE_LINE_EDIT, traverses to the +next tab group if the direction argument is Next, or to the previous +tab group if the direction is Prev. If XmNeditMode is +XmMULTI_LINE_EDIT, and the direction is Next, the action +inserts a tab. The Prev direction has no effect with +XmMULTI_LINE_EDIT. +In the Text widget, there is a preset tab stop at every eighth columns. + +The process-tab() action under multi-line editing produces calls +to the XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. Under single-line editing, the action +produces no callbacks, unless it results in the widget losing focus, +in which case, the XmNlosingFocusCallback procedures are called +with reason value XmCR_LOSING_FOCUS. + + + + +process-up(extend): + +If XmNeditMode is XmSINGLE_LINE_EDIT and +XmNnavigationType is XmNONE, +traverses to the widget above the current one in the tab group. + +If XmNeditMode is XmMULTI_LINE_EDIT, +moves the insertion cursor up one line. + +If XmNeditMode is XmMULTI_LINE_EDIT and this action is +called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The process-up() action under multi-line editing produces calls +to the XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. Under single-line editing, the action +produces no callbacks unless it results in the widget losing focus, in +which case, the XmNlosingFocusCallback procedures are called +with reason value XmCR_LOSING_FOCUS. + +In vertical writing, moves the insertion cursor one character +up. + + + + +redraw-display(): + +Redraws the contents of the text window. + +The redraw-display() action produces no callbacks. + + + + +scroll-cursor-vertically(percentage): + +Scrolls the line containing the insertion cursor vertically +to an intermediate position in the visible window based on an +input percentage. A value of 0 indicates the top of the window; +a value of 100, the bottom of the window. If this action is called +with no argument, the line containing the insertion cursor is scrolled +vertically to a new position designated by the y position +of the event passed to the routine. + +The scroll-cursor-vertically action produces no callbacks. + + + + +scroll-one-line-down(): + +Scrolls the text area down one line. + +The scroll-one-line-down() action produces no callbacks. + + + + +scroll-one-line-up(): + +Scrolls the text area up one line. + +The scroll-one-line-up() action produces no callbacks. + + + + +secondary-adjust(): + +Extends the secondary selection to the pointer position. + +The secondary-adjust() action produces no callbacks. + + + + +secondary-notify(): + +Copies the secondary selection to the insertion cursor of the +destination widget. + +The secondary-notify() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +secondary-start(): + +Marks the beginning of a secondary selection. + +The secondary-start() action produces no callbacks. + + + + +select-adjust(): + +Moves the current selection. +The amount of text selected depends on the number of mouse clicks, as +specified by the XmNselectionArray resource. + +The select-adjust() action may produce no callbacks, +however, it may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +select-all(): + +Selects all text. + +The select-all() action may produce calls to the +XmNgainPrimaryCallback procedures. + + + + +select-end(): + +Moves the current selection. +The amount of text selected depends on the number of mouse clicks, as +specified by the XmNselectionArray resource. + +The select-end() action produces no callbacks. + + + + +select-start(): + +Marks the beginning of a new selection region. + +The select-start() action may produce calls to the +XmNgainPrimaryCallback procedures. + + + + +self-insert(): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts the character associated with the key pressed +at the insertion cursor. + +The self-insert() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +set-anchor(): + +Resets the anchor point for extended selections. +Resets the destination of secondary selection actions. + +The set-anchor() action produces no callbacks. + + + + +set-insertion-point(): + +Sets the insertion position to the position of the mouse pointer. + +The set-insertion-point() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. Note that if the mouse pointer is +already over the position of the insertion cursor, the cursor will not +be moved, and no callbacks will be produced. + + + + +set-selection-hint(): + +Sets the text source and location of the current selection. + +The set-selection-hint() action produces no callbacks. + + + + +toggle-add-mode(): + +Toggles the state of Add Mode. + +The toggle-add-mode() action produces no callbacks. + + + + +toggle-overstrike(): + +Toggles the state of the text insertion mode. By default, +characters typed into the Text widget are inserted at +the position of the insertion cursor. In overstrike +mode, characters entered into the Text widget replace +the characters that directly follow the insertion cursor. +In overstrike mode, when the end of a line is reached, +characters are appended to the end of the line. + +The following traversal actions generate no callbacks unless they +result in the loss of focus by the widget in question, as when +XmNnavigationType is XmNONE. In this case, +they produce calls to the XmNlosingFocusCallback procedures, +with reason value XmCR_FOCUS_MOVED. + + + + +traverse-home(): + +Traverses to the first widget in the tab group. + + + + +traverse-next(): + +Traverses to the next widget in the tab group. + + + + +traverse-prev(): + +Traverses to the previous widget in the tab group. + + + + +unkill(): + +Restores last killed text to the position of the insertion +cursor (or whatever is currently in the CUT_BUFFER0). +The inserted text appears before the insertion cursor. + +The unkill() action produces calls to the XmNmodifyVerifyCallback +procedures with reason value XmCR_MODIFYING_TEXT_VALUE, the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED, and the XmNmotionVerifyCallback +procedures with reason value XmCR_MOVING_INSERT_CURSOR. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +FocusIn: + +Draws the insertion cursor as solid and starts blinking the cursor. + + + + +FocusOut: + +Displays the insertion cursor as a stippled I-beam unless it is the +destination widget +and stops the cursor from blinking. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see +&cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmCreateScrolledText;, +&cdeman.XmCreateText;, +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmPrimitive;, +&cdeman.XmTextClearSelection;, +&cdeman.XmTextCopy;, +&cdeman.XmTextCopyLink;, +&cdeman.XmTextCut;, +&cdeman.XmTextEnableRedisplay;, +&cdeman.XmTextDisableRedisplay;, +&cdeman.XmTextField;, +&cdeman.XmTextFindString;, +&cdeman.XmTextFindStringWcs;, +&cdeman.XmTextGetBaseline;, +&cdeman.XmTextGetEditable;, +&cdeman.XmTextGetInsertionPosition;, +&cdeman.XmTextGetLastPosition;, +&cdeman.XmTextGetMaxLength;, +&cdeman.XmTextGetSelection;, +&cdeman.XmTextGetSelectionWcs;, +&cdeman.XmTextGetSelectionPosition;, +&cdeman.XmTextGetSource;, +&cdeman.XmTextGetString;, +&cdeman.XmTextGetStringWcs;, +&cdeman.XmTextGetSubstring;, +&cdeman.XmTextGetSubstringWcs;, +&cdeman.XmTextGetTopCharacter;, +&cdeman.XmTextInsert;, +&cdeman.XmTextInsertWcs;, +&cdeman.XmTextPaste;, +&cdeman.XmTextPasteLink;, +&cdeman.XmTextPosToXY;, +&cdeman.XmTextPosition;, +&cdeman.XmTextRemove;, +&cdeman.XmTextReplace;, +&cdeman.XmTextReplaceWcs;, +&cdeman.XmTextScroll;, +&cdeman.XmTextSetAddMode;, +&cdeman.XmTextSetEditable;, +&cdeman.XmTextSetHighlight;, +&cdeman.XmTextSetInsertionPosition;, +&cdeman.XmTextSetMaxLength;, +&cdeman.XmTextSetSelection;, +&cdeman.XmTextSetSource;, +&cdeman.XmTextSetString;, +&cdeman.XmTextSetStringWcs;, +&cdeman.XmTextSetTopCharacter;, +&cdeman.XmTextShowPosition;, and +&cdeman.XmTextXYToPos;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBA.sgm new file mode 100644 index 00000000..860fb247 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBA.sgm @@ -0,0 +1,1600 @@ + + + + + + + + + + +XmToggleButton +library call + + +XmToggleButton +The ToggleButton widget class + +XmToggleButton + +widget class +ToggleButton + + + +#include <Xm/ToggleB.h> + + + +DESCRIPTION +ToggleButton sets nontransitory state data within an +application. Usually this widget consists of an indicator +(square, diamond, or round) +with either text or a pixmap on one side of it. +However, it can also consist of just text or a pixmap without the indicator. + +The toggle graphics display a 1-of-many, N-of-many, or +1-of-many-round selection state. +When a toggle indicator is displayed, a square indicator shows an +N-of-many +selection state, a diamond-shaped indicator shows a +1-of-many selection state, and a circle-shaped indicator shows a +1-of-many-round selection state. + +ToggleButton +implies a set or unset state. +In the case of a label and an indicator, an +empty indicator (square, diamond, or round) indicates that ToggleButton +is unset, and a filled indicator shows that it is +set. The indicator may be filled with a check mark, a cross, or the +select color. In the case of a pixmap +toggle, different pixmaps are used to display the set/unset +states. +ToggleButton can also indicate an indeterminate state. In the case of +a label and an indicator, an indeterminate state is indicated by a +stippled flat box. +In the case of a pixmap toggle, a different pixmap is used to display +the indeterminate state. + +The default behavior associated with a ToggleButton in a menu depends on +the type of menu system in which it resides. +By default, Btn1 controls the behavior of the ToggleButton. +In addition, Btn3 controls the behavior of the ToggleButton if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. + +Label's resource XmNmarginLeft may +be increased +to accommodate the toggle indicator when it is created. + +ToggleButton uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits. + + +Classes +ToggleButton inherits behavior, resources, and traits from +Core, XmPrimitive, and XmLabel. + +The class pointer is xmToggleButtonWidgetClass. + +The class name is XmToggleButton. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmToggleButton Resource Set + + +Name +Class +Type +Default +Access + + +XmNarmCallback +XmCArmCallback +XtCallbackList +NULL +C + + +XmNdetailShadowThickness +XmCDetailShadowThickness +Dimension +2 +CSG + + +XmNdisarmCallback +XmCDisarmCallback +XtCallbackList +NULL +C + + +XmNfillOnSelect +XmCFillOnSelect +Boolean +dynamic +CSG + + +XmNindeterminatePixmap +XmCIndeterminatePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNindicatorOn +XmCIndicatorOn +unsigned char +XmINDICATOR_FILL +CSG + + +XmNindicatorSize +XmCIndicatorSize +Dimension +dynamic +CSG + + +XmNindicatorType +XmCIndicatorType +unsigned char +dynamic +CSG + + +XmNselectColor +XmCSelectColor +Pixel +dynamic +CSG + + +XmNselectInsensitivePixmap +XmCSelectInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNselectPixmap +XmCSelectPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNset +XmCSet +unsigned char +XmUNSET +CSG + + +XmNspacing +XmCSpacing +Dimension +4 +CSG + + +XmNtoggleMode +XmCToggleMode +unsigned char +XmTOGGLE_BOOLEAN +CSG + + +XmNunselectColor +XmCUnselectColor +Pixel +dynamic +CSG + + +XmNvalueChangedCallback +XmCValueChangedCallback +XtCallbackList +NULL +C + + +XmNvisibleWhenOff +XmCVisibleWhenOff +Boolean +dynamic +CSG + + + + + + +XmNarmCallback + +Specifies the list of callbacks called +when the ToggleButton is armed. +To arm this widget, press the active mouse button +while the pointer is inside the ToggleButton. +For this callback, the reason is XmCR_ARM. + + + + +XmNdetailShadowThickness + +Specifies the thickness of the indicator shadow. The +default thickness +is 2 pixels. + + + + +XmNdisarmCallback + +Specifies the list of callbacks called +when ToggleButton is disarmed. +To disarm this widget, press and release the active +mouse button while the pointer is inside the ToggleButton. +This widget is also disarmed +when the user moves out of the widget +and releases the mouse button when the pointer is outside the widget. +For this callback, the reason is XmCR_DISARM. + + + + +XmNfillOnSelect + +Fills the indicator with the color specified in +XmNselectColor and switches the top and bottom shadow +colors when set to True. If unset, fills the indicator with the +unselect color. If indeterminate, fills the indicator with +half select color and half unselect color. Otherwise, it switches +only the top +and bottom shadow colors. The default is +True only if a box type of indicator +(such as a check box) is specified, or if the XmNindicatorType is a +1-of type and a toggle indicator is drawn. + +If XmNfillOnSelect is True, XmNset is XmSET, and +XmNindicatorOn is XmINDICATOR_NONE the ToggleButton's +background is set to XmNselectColor. For the other +XmNindicatorOn values, only the indicator is filled with +XmNselectColor. + + + + +XmNindeterminateInsensitivePixmap + +Specifies the pixmap to be displayed as the button face when +the Label XmNlableType resource is XmPIXMAP, +the ToggleButton XmNset resource is XmINDETERMINATE, +and the Core XmNsensitive resource is False. + + + + +XmNindeterminatePixmap + +Specifies the pixmap to be displayed as the button face when +the Label XmNlableType resource is XmPIXMAP, +the ToggleButton XmNset resource is XmINDETERMINATE, +and the Core XmNsensitive resource is True. + + + + +XmNindicatorOn + +Specifies that if a toggle indicator is to be drawn, it will be drawn +to one side of the toggle +text or pixmap, depending on the XmNlayoutDirection resource of +the widget. The default value is XmINDICATOR_FILL. +Toggles accept the following values: + + + +XmINDICATOR_NONE + +No space is allocated +for the indicator, and it is not displayed. Any shadows around the +entire widget are switched when the toggle is selected or unselected. + + + + +XmINDICATOR_BOX + +The toggle indicator is in the shape of a shadowed box. + + + + +XmINDICATOR_FILL + +If the value of the +XmDisplay XmNenableToggleVisual +resource is +True +, the visuals are those of +XmINDICATOR_CHECK_BOX +; if +False +, the indicator visuals are those of +XmINDICATOR_BOX. + + + + +XmINDICATOR_CHECK + +The toggle indicator is in the shape of a checkmark in the +foreground color. + + + + +XmINDICATOR_CHECK_BOX + +The toggle indicator is in the shape of a checkmark enclosed in a box. +This is the default if the XmDisplay XmNenableToggleVisual +resource is set. + + + + +XmINDICATOR_CROSS_BOX + +The toggle indicator is in the shape of a cross enclosed in a box. + + + + +XmINDICATOR_CROSS + +The toggle indicator is in the shape of a cross. + + + + +All ToggleButton checks and crosses should be drawn in the +foreground color. + +If this resource is not XmINDICATOR_NONE, it will control the +appearance of the toggle visual. If XmNset is +XmINDETERMINATE and XmNindicatorOn is not +XmINDICATOR_NONE, this resource +shows a stippled flat box. +If XmNset is XmINDETERMINATE, XmNindicatorOn is +XmINDICATOR_NONE, and XmNtoggleMode is +XmTOGGLE_INDETERMINATE, the label and the ToggleButton are stippled with +a combination of the XmNselectColor and +the XmNunselectColor color, +and the border is flat. + + + + +XmNindicatorSize + +Sets the size of the indicator. +If no value is specified, the size of the indicator is based on the size +of the label string or pixmap. +If the label string or pixmap changes, the size of the indicator is +recomputed based on the size of the label string or pixmap. +Once a value has been specified for XmNindicatorSize, the +indicator has that size, regardless of the size of the label string or +pixmap, until a new value is specified. +The size of indicators inside menus may differ from those outside of menus. +Note that a change in this resource may also cause a change in the +values of the inherited resources XmNmarginTop, +XmNmarginBottom, and XmNmarginLeft. + + + + +XmNindicatorType + +Specifies if the indicator is a 1-of or +N-of indicator. For the 1-of indicator, the +value can be XmONE_OF_MANY, +XmONE_OF_MANY_ROUND, or +XmONE_OF_MANY_DIAMOND. +For the N-of indicator, +the value is XmN_OF_MANY. +This value specifies only the visuals and does not enforce the +behavior. When the ToggleButton is in a radio box, the default is +XmONE_OF_MANY; otherwise, +the default is +XmN_OF_MANY. Legal values +are: + + + +XmONE_OF_MANY + +When the Display XmNenableToggleVisual +resource is set, +indicators are drawn with the same appearance as +XmONE_OF_MANY_ROUND; +otherwise, they appear the same as +XmONE_OF_MANY_DIAMOND. + + + + +XmN_OF_MANY + +The indicators are drawn as specified by the +XmNindicatorOn +resource. + + + + +XmONE_OF_MANY_ROUND + +A shadowed circle. + + + + +XmONE_OF_MANY_DIAMOND + +A shadowed diamond. + + + + + + + +XmNselectColor + +Allows the application to specify what color fills +the center of the square, diamond-shaped, or round indicator when it is set. +If this color is the same as either the top or the bottom shadow color of the +indicator, a one-pixel-wide margin is left between the shadows and the fill; +otherwise, it is filled completely. +The results of this resource depend on the value of the Display +resource XmNenableToggleColor. A value of True causes the fill +color to use the XmHIGHLIGHT_COLOR color by default. A value of +False causes the fill +color to use the background color. +This resource's default for a color display is a color between the background +and the bottom shadow color. For a monochrome display, the default is set to +the foreground color. To set the background of the button to +XmNselectColor when XmNindicatorOn is XmINDICATOR_NONE, +the value of +XmNfillOnSelect must be explicitly set to True. + +This resource is also used as the background color when all of the following conditions +are met: the button is armed in a menu, the +XmNenableEtchedInMenu resource is True, +the XmNindicatorOn resource is False, and the +XmNfillOnSelect resource is True. + +This resource can take the following values: + + + +XmDEFAULT_SELECT_COLOR + +Is the same as the current dynamic default, which is a color between +the background and the bottom shadow color. + + + + +XmREVERSED_GROUND_COLORS + +Forces the select color to the +foreground color and causes the default color of any text rendered over the +select color to be in the background color. + + + + +XmHIGHLIGHT_COLOR + +Forces the fill color to use the highlight color. + + + + + + + +XmNselectInsensitivePixmap + +Specifies a pixmap used as the button face when the ToggleButton is selected, +the button is insensitive, and the Label resource +XmNlabelType is set to XmPIXMAP. +If the ToggleButton is unselected and the button is insensitive, +the pixmap in +XmNlabelInsensitivePixmap is used as the button face. +If no value is specified for XmNlabelInsensitivePixmap, that +resource is set to the value specified for +XmNselectInsensitivePixmap. + + + + +XmNselectPixmap + +Specifies the pixmap to be used as the button +face when XmNlabelType is XmPIXMAP and +the ToggleButton is selected. +When the ToggleButton is unselected, +the pixmap specified in the Label's XmNlabelPixmap is used. +If no value is specified for XmNlabelPixmap, that resource is set +to the value specified for XmNselectPixmap. + + + + +XmNset + +Represents the state of the ToggleButton. +A value of XmUNSET indicates that the ToggleButton is not set. +A value of XmSET indicates that the ToggleButton is set. +A value of XmINDETERMINATE indicates that the +ToggleButton is in an indeterminate state (neither set nor unset). +The ToggleButton states cycle through in the order of XmSET, +XmINDETERMINATE (if XmNtoggleMode is set to +XmTOGGLE_INDETERMINATE), and XmUNSET, and then +back around to XmSET. If XmNtoggleMode is +set to XmTOGGLE_BOOLEAN, then the ToggleButton states cycle +through in the order of XmSET, then XmUNSET, and then +back around to XmSET. +Setting this resource sets the state of the +ToggleButton. + + + + +XmNspacing + +Specifies the amount of spacing between the toggle indicator and the +toggle label (text or pixmap). + + + + +XmNtoggleMode + +Specifies the mode of the ToggleButton as either +XmTOGGLE_BOOLEAN or XmTOGGLE_INDETERMINATE. The +XmTOGGLE_INDETERMINATE value allows the XmNset resource to +be able to accept the values XmINDETERMINATE, XmSET, and +XmUNSET. The XmNtoggleMode resource is forced to +XmTOGGLE_BOOLEAN if the toggle is in an XmRowColumn widget +whose radio behavior is XmONE_OF_MANY. In +XmTOGGLE_BOOLEAN mode, the XmNset resource can only accept +XmSET and XmUNSET. + + + + +XmNunselectColor + +Allows the application to specify what color fills +the center of the square, diamond-shaped, or round indicator when it +is not set. +If this color is the same as either the top or the bottom shadow color of the +indicator, a one-pixel-wide margin is left between the shadows and the fill; +otherwise, it is filled completely. +This resource's default for a color display is XmNbackground. +For a monochrome display, the default is set to +the background color. To set the background of the button to +XmNunselectColor when XmNindicatorOn is +XmINDICATOR_NONE, the value of +XmNfillOnSelect must be explicitly set to True. This resource +acts like the XmNselectColor resource, but for the case when +XmNset is XmUNSET. + + + + +XmNvalueChangedCallback + +Specifies the list of callbacks called +when the ToggleButton value +is changed. To change the value, +press and release the active mouse button while the pointer +is inside the ToggleButton. This action +also causes this widget to be disarmed. +For this callback, the reason is XmCR_VALUE_CHANGED. + + + + +XmNvisibleWhenOff + +Indicates that the toggle indicator is visible in the unselected state when +the Boolean value is True. +When the ToggleButton is in a menu, the default value is False. +When the ToggleButton is in a RadioBox, the default value is True. + + + + + + +Inherited Resources +ToggleButton inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabel Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +dynamic +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +0 +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +XmFONTLIST_DEFAULT_TAG +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int set; +} XmToggleButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +set + +Reflects the ToggleButton's state, either +XmSET (selected), XmUNSET (unselected), or +XmINDETERMINATE (neither). +Note that the reported state is the state that the ToggleButton +is in after the event has been processed. For example, +suppose that a user clicks on a ToggleButton to change it from +the unselected state to the selected state. In this case, +ToggleButton changes the value of set from XmUNSET +to XmSET prior to calling the callback. + + + + + + + + + + + + + + + + +Translations +XmToggleButton includes translations from Primitive. +Additional XmToggleButton translations for buttons not in a +menu system are described in the following list. + +Note that altering translations in #override +or #augment mode is undefined. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +c<Btn1Down>: + +ButtonTakeFocus() + + + + +≈cBtn1Down: + +Arm() + + + + +≈cBtn1Up: + +Select() Disarm() + + + + +Btn2Down: + +ProcessDrag() + + + + +:KeyosfActivate: + +PrimitiveParentActivate() + + + + +:KeyosfCancel: + +PrimitiveParentCancel() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfHelp: + +Help() + + + + +≈s ≈m ≈a KeyReturn: + +PrimitiveParentActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + +XmToggleButton inherits menu traversal translations +from XmLabel. +Additional XmToggleButton translations for ToggleButtons in a +menu system are described in the following list. +In a Popup menu system, Btn3 also performs the Btn1 +actions. + + + +Btn2Down: + +ProcessDrag() + + + + +c<Btn1Down>: + +MenuButtonTakeFocus() + + + + +c<Btn1Up>: + +MenuButtonTakeFocusUp() + + + + +≈cBtnDown: + +BtnDown() + + + + +≈cBtnUp: + +BtnUp() + + + + +:KeyosfSelect: + +ArmAndActivate() + + + + +:KeyosfActivate: + +ArmAndActivate() + + + + +:KeyosfHelp: + +Help() + + + + +:KeyosfCancel: + +MenuEscape() + + + + +≈s ≈m ≈a KeyReturn: + +ArmAndActivate() + + + + +≈s ≈m ≈a Keyspace: + +ArmAndActivate() + + + + + + + +Action Routines +The XmToggleButton action routines are + + + +Arm(): + +If the button was previously unset, this action does the following: +if XmNindicatorOn is True, it draws the indicator shadow so that +the indicator looks pressed; if XmNfillOnSelect is True, it fills +the indicator with the color specified by XmNselectColor. +If XmNindicatorOn is False, it draws the +button shadow so +that the +button looks pressed. +If XmNlabelType is XmPIXMAP, the XmNselectPixmap is +used as the button face. +This action calls the XmNarmCallback callbacks. + +If the button was previously set, this action does the following: +if both XmNindicatorOn and XmNvisibleWhenOff are True, it +draws the indicator shadow so that the indicator looks raised; if +XmNfillOnSelect is True, it fills the indicator with the +background color. +If XmNindicatorOn is False, it draws the button shadow +so that the button looks raised. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used as the button face. +This action calls the XmNarmCallback callbacks. + + + + +ArmAndActivate(): + +If the ToggleButton was previously set, unsets it; if the ToggleButton +was previously unset, sets it. + +In a menu, this action +unposts all menus in the menu hierarchy. +Unless the button is already armed, +it calls the XmNarmCallback callbacks. +This action calls the XmNvalueChangedCallback and +XmNdisarmCallback callbacks. + +Outside a menu, if the button was previously unset, this action does the +following: +if XmNindicatorOn is True, it draws the indicator shadow so that +the indicator looks pressed; if XmNfillOnSelect is True, it fills +the indicator with the color specified by +XmNselectColor. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks pressed. +If XmNlabelType is XmPIXMAP, the XmNselectPixmap is +used as the button face. +This action calls the XmNarmCallback, XmNvalueChangedCallback, and +XmNdisarmCallback callbacks. + +Outside a menu, if the button was previously set, this action does the +following: +if both XmNindicatorOn and XmNvisibleWhenOff are True, it +draws the indicator shadow so that the indicator looks raised; if +XmNfillOnSelect is True, it fills the indicator with the +background color. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks raised. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used as the button face. +This action calls the XmNarmCallback, XmNvalueChangedCallback, and +XmNdisarmCallback callbacks. + + + + +BtnDown(): + +This action unposts any menus posted by the ToggleButton's parent menu, +disables keyboard traversal for the menu, and enables mouse traversal +for the menu. +It draws the shadow in the armed state +and, unless the button is already armed, calls the XmNarmCallback +callbacks. + + + + +BtnUp(): + +This action unposts all menus in the menu hierarchy. +If the ToggleButton was previously set, unsets it; if the ToggleButton +was previously unset, sets it. +It calls the XmNvalueChangedCallback callbacks and then the +XmNdisarmCallback callbacks. + + + + +ButtonTakeFocus(): + +Causes the ToggleButton to take keyboard focus +when Ctrl<Btn1Down> is pressed, without activating the widget. + + + + +Disarm(): + +Calls the callbacks for XmNdisarmCallback. + + + + +Help(): + +In a Pulldown or Popup MenuPane, unposts all menus in the menu hierarchy +and restores keyboard focus to the widget that had the focus before +the menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +MenuShellPopdownOne(): + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, unposts the menu. + +In a Popup MenuPane, unposts the menu and restores keyboard focus to the +widget from which the menu was posted. + + + + +ProcessDrag(): + +Drags the contents of a ToggleButton label, identified when +BTransfer is pressed. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. +This action is undefined for ToggleButtons used in a menu system. + + + + +Select(): + +If the pointer is within the button, takes the following actions: +If the button was previously unset, sets it; if the button was +previously set, unsets it. +This action calls the XmNvalueChangedCallback callbacks. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +EnterWindow: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the armed state and calls the +XmNarmCallback callbacks. + +If the ToggleButton is not in a menu and the cursor leaves and then +reenters the ToggleButton's window while the button is pressed, this +action restores the button's armed appearance. + + + + +LeaveWindow: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the unarmed state and calls the +XmNdisarmCallback callbacks. + +If the ToggleButton is not in a menu and the cursor leaves the +ToggleButton's window while the button is pressed, this action restores +the button's unarmed appearance. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateToggleButton;, &cdeman.XmLabel;, +&cdeman.XmPrimitive;, &cdeman.XmRowColumn;, &cdeman.XmToggleButtonGetState;, +and &cdeman.XmToggleButtonSetState;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBB.sgm new file mode 100644 index 00000000..36b2814e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBB.sgm @@ -0,0 +1,1337 @@ + + + + + + + + + + +XmToggleButtonGadget +library call + + +XmToggleButtonGadget +The ToggleButtonGadget widget class + +XmToggleButtonGadget + +widget class +ToggleButtonGadget + + + +#include <Xm/ToggleBG.h> + + + +DESCRIPTION +ToggleButtonGadget sets nontransitory state data within an +application. Usually this gadget consists of an indicator +(square, diamond, or round) +with either text or a pixmap on one side of it. +However, +it can also consist of just text or a pixmap without the indicator. + +The toggle graphics display a 1-of-many, N-of-many, or +N-of-many-round selection state. +When a toggle indicator is displayed, a square indicator shows an +N-of-many +selection state, a diamond-shaped indicator shows a +1-of-many selection state, and a circle-shaped indicator shows a +1-of-many-round selection state. + +ToggleButtonGadget +implies a set or unset state. +In the case of a label and an indicator, an +empty indicator (square, diamond, or round) indicates that +ToggleButtonGadget +is unset, and a filled indicator shows that it is +set. The indicator may be filled with a check mark or the +select color. In the case of a pixmap +toggle, different pixmaps are used to display the set/unset +states. +ToggleButtonGadget can also indicate an indeterminate state. In the case of +a label and an indicator, an indeterminate state is indicated by a +stippled flat box. +In the case of a pixmap toggle, a different pixmap is used to display +the indeterminate state. + +The default behavior associated with a ToggleButtonGadget in a menu depends on +the type of menu system in which it resides. +By default, Btn1 controls the behavior of the ToggleButtonGadget. +In addition, Btn3 controls the behavior of the ToggleButtonGadget if +it resides in a PopupMenu system. +The actual mouse button used is determined by its RowColumn parent. + +Label's resource XmNmarginLeft may +be increased +to accommodate the toggle indicator when it is created. + +ToggleButtonGadget uses the XmQTmenuSystem and +XmQTspecifyRenderTable traits. + + +Classes +ToggleButtonGadget inherits behavior, +resources, and traits from Object, RectObj, XmGadget +and XmLabelGadget. + +The class pointer is xmToggleButtonGadgetClass. + +The class name is XmToggleButtonGadget. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lowercase or uppercase, but include any +underscores between +words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), or is not applicable (N/A). + + + + + + + + + + + +XmToggleButtonGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNarmCallback +XmCArmCallback +XtCallbackList +NULL +C + + +XmNdetailShadowThickness +XmCDetailShadowThickness +Dimension +2 +CSG + + +XmNdisarmCallback +XmCDisarmCallback +XtCallbackList +NULL +C + + +XmNfillOnSelect +XmCFillOnSelect +Boolean +dynamic +CSG + + +XmNindeterminatePixmap +XmCIndeterminatePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNindicatorOn +XmCIndicatorOn +unsigned char +XmINDICATOR_FILL +CSG + + +XmNindicatorSize +XmCIndicatorSize +Dimension +dynamic +CSG + + +XmNindicatorType +XmCIndicatorType +unsigned char +dynamic +CSG + + +XmNselectColor +XmCSelectColor +Pixel +dynamic +CSG + + +XmNselectInsensitivePixmap +XmCSelectInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNselectPixmap +XmCSelectPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNset +XmCSet +unsigned char +XmUNSET +CSG + + +XmNspacing +XmCSpacing +Dimension +4 +CSG + + +XmNtoggleMode +XmCToggleMode +unsigned char +XmTOGGLE_BOOLEAN +CSG + + +XmNunselectColor +XmCUnselectColor +Pixel +dynamic +CSG + + +XmNvalueChangedCallback +XmCValueChangedCallback +XtCallbackList +NULL +C + + +XmNvisibleWhenOff +XmCVisibleWhenOff +Boolean +dynamic +CSG + + + + + + +XmNarmCallback + +Specifies a list of callbacks +that is called when the ToggleButtonGadget is armed. +To arm this gadget, press the active mouse button +while the pointer is inside the ToggleButtonGadget. +For this callback, the reason is XmCR_ARM. + + + + +XmNdetailShadowThickness + +Specifies the thickness of the indicator shadow. The default thickness +is 2 pixels. + + + + +XmNdisarmCallback + +Specifies a list of callbacks +called when ToggleButtonGadget is disarmed. +To disarm this gadget, press and release the active +mouse button while the pointer is inside the ToggleButtonGadget. +The gadget is also disarmed +when the user moves out of the gadget +and releases the mouse button when the pointer is outside the gadget. +For this callback, the reason is XmCR_DISARM. + + + + +XmNfillOnSelect + +Fills the indicator with the color specified in +XmNselectColor and switches the top and bottom shadow +colors when set to True. If unset, fills the indicator with the +unselect color. If indeterminate, fills the indicator with +half select color and half unselect color. +Otherwise, it switches only the top +and bottom shadow colors. The default is set +True only if a box type of indicator +(such as a check box) is specified, or if the XmNindicatorType is a +1-of type and a toggle indicator is drawn. +If XmNfillOnSelect is True, XmNset is XmSET, and +XmNindicatorOn is XmINDICATOR_NONE the ToggleButtonGadget's +background is set to XmNselectColor. For the other +XmNindicatorOn values, only the indicator is filled with +XmNselectColor. + + + + +XmNindeterminateInsensitivePixmap + +Specifies the pixmap to be displayed as the button face when +the Label XmNlableType resource is XmPIXMAP, +the ToggleButtonGadget XmNset resource is XmINDETERMINATE, +and the Core XmNsensitive resource is False. + + + + +XmNindeterminatePixmap + +Specifies the pixmap to be displayed as the button face when +the Label XmNlableType resource is XmPIXMAP, +the ToggleButtonGadget XmNset resource is XmINDETERMINATE, +and the Core XmNsensitive resource is True. + + + + +XmNindicatorOn + +Specifies that if a toggle indicator is to be drawn, it will be drawn +to one side of the toggle +text or pixmap, depending on the XmNlayoutDirection resource of +the widget. The default value is XmINDICATOR_FILL. +Toggles accept the following values: + + + +XmINDICATOR_NONE + +No space is allocated +for the indicator, and it is not displayed. Any shadows around the +entire widget are switched when the toggle is selected or unselected. + + + + +XmINDICATOR_BOX + +The toggle indicator is in the shape of a shadowed box. + + + + +XmINDICATOR_FILL + +If the value of the +XmDisplay XmNenableToggleVisual +resource is +True +, the visuals are those of +XmINDICATOR_CHECK_BOX +; if +False +, the indicator visuals are those of +XmINDICATOR_BOX. + + + + +XmINDICATOR_CHECK + +The toggle indicator is in the shape of a checkmark in the +foreground color. + + + + +XmINDICATOR_CHECK_BOX + +The toggle indicator is in the shape of a checkmark enclosed in a box. +This is the default if the XmDisplay XmNenableToggleVisual +resource is set. + + + + +XmINDICATOR_CROSS_BOX + +The toggle indicator is in the shape of a cross enclosed in a box. + + + + +XmINDICATOR_CROSS + +The toggle indicator is in the shape of a cross. + + + + +All ToggleButton checks and crosses should be drawn in the +foreground color. + +If this resource is not XmINDICATOR_NONE, it will control the +appearance of the toggle visual. If XmNset is +XmINDETERMINATE and XmNindicatorOn is not +XmINDICATOR_NONE, this resource +shows a stippled flat box. +If XmNset is XmINDETERMINATE, XmNindicatorOn is +XmINDICATOR_NONE, and XmNtoggleMode is +XmTOGGLE_INDETERMINATE, the label and the ToggleButton are stippled with +a combination of the XmNselectColor and +the XmNunselectColor color, +and the border is flat. + + + + +XmNindicatorSize + +Sets the size of the indicator. +If no value is specified, the size of the indicator is based on the size +of the label string or pixmap. +If the label string or pixmap changes, the size of the indicator is +recomputed based on the size of the label string or pixmap. +Once a +value has been specified for XmNindicatorSize, the +indicator has that size, regardless of the size of the label string or +pixmap, until a new value is specified. +The size of indicators inside menus may differ from those outside of menus. +Note that a change in this resource may also cause a change in the +values of the inherited resources XmNmarginTop, +XmNmarginBottom, and XmNmarginLeft. + + + + +XmNindicatorType + +Specifies if the indicator is a 1-of or +N-of indicator. For the 1-of indicator, the +value can be XmONE_OF_MANY, +XmONE_OF_MANY_ROUND, or +XmONE_OF_MANY_DIAMOND. +For the N-of indicator, +the value is XmN_OF_MANY. +This value specifies only the visuals and does not enforce the +behavior. When the ToggleButton is in a radio box, the default is +XmONE_OF_MANY; otherwise, +the default is +XmN_OF_MANY. Legal values +are: + + + +XmONE_OF_MANY + +When the Display XmNenableToggleVisual +resource is set, +indicators are drawn with the same appearance as +XmONE_OF_MANY_ROUND; +otherwise, they appear the same as +XmONE_OF_MANY_DIAMOND. + + + + +XmN_OF_MANY + +The indicators are drawn as specified by the +XmNindicatorOn +resource. + + + + +XmONE_OF_MANY_ROUND + +A shadowed circle. + + + + +XmONE_OF_MANY_DIAMOND + +A shadowed diamond. + + + + + + + +XmNselectColor + +Allows the application to specify what color fills +the center of the square, diamond-shaped, or round indicator when it is set. +If this color is the same as either the top or the bottom shadow color of the +indicator, a one-pixel-wide margin is left between the shadows and the fill; +otherwise, it is filled completely. +The results of this resource depend on the value of the Display +resource XmNenableToggleColor. A value of True causes the fill +color to use the XmHIGHLIGHT_COLOR color by default. A value of False +causes the fill +color to use the background color. +This resource's default for a color display is a color between the background +and the bottom shadow color. For a monochrome display, the default is set to +the foreground color. To set the background of the button to +XmNselectColor when XmNindicatorOn is XmINDICATOR_NONE, +the value of +XmNfillOnSelect must be explicitly set to True. + +This resource can take the following values: + + + +XmDEFAULT_SELECT_COLOR + +Is the same as the current dynamic default, which is a color between +the background and the bottom shadow color. + + + + +XmREVERSED_GROUND_COLORS + +Forces the select color to the +foreground color and causes the default color of any text rendered over the +select color to be in the background color. + + + + +XmHIGHLIGHT_COLOR + +Forces the fill color to use the highlight color. + + + + + + + + +XmNselectInsensitivePixmap + +Specifies a pixmap used as the button face when the ToggleButtonGadget +is selected, +the button is insensitive, and the LabelGadget resource XmNlabelType +is XmPIXMAP. If the ToggleButtonGadget +is unselected and the button is insensitive, the pixmap in +XmNlabelInsensitivePixmap is used as the button face. +If no value is specified for XmNlabelInsensitivePixmap, that +resource is set to the value specified for +XmNselectInsensitivePixmap. + + + + +XmNselectPixmap + +Specifies the pixmap to be used as the button +face if XmNlabelType is XmPIXMAP and +the ToggleButtonGadget is selected. +When the ToggleButtonGadget is unselected, +the pixmap specified in LabelGadget's XmNlabelPixmap is used. +If no value is specified for XmNlabelPixmap, that resource is set +to the value specified for XmNselectPixmap. + + + + +XmNset + +Represents the state of the ToggleButton. A value of XmUNSET indicates +that the ToggleButton is not set. A value of XmSET indicates that +the ToggleButton is set. A value of XmINDETERMINATE indicates that the +ToggleButton is in an indeterminate state (neither set nor unset). +The ToggleButton states cycle through in the order of XmSET, +XmINDETERMINATE (if XmNtoggleMode is set to +XmTOGGLE_INDETERMINATE), and XmUNSET, and then +back around to XmSET. If XmNtoggleMode is +set to XmTOGGLE_BOOLEAN, then the ToggleButton states cycle +through in the order of XmSET, then XmUNSET, and then +back around to XmSET. +Setting this resource sets the state of the +ToggleButton. + + + + +XmNspacing + +Specifies the amount of spacing between the toggle indicator and the +toggle label (text or pixmap). + + + + +XmNtoggleMode + +Specifies the mode of the ToggleButtonGadget as either +XmTOGGLE_BOOLEAN or XmTOGGLE_INDETERMINATE. The +XmTOGGLE_INDETERMINATE value allows the XmNset resource to +be able to accept the values XmINDETERMINATE, XmSET, and +XmUNSET. The XmNtoggleMode resource is forced to +XmTOGGLE_BOOLEAN if the toggle is in an XmRowColumn widget +whose radio behavior is XmONE_OF_MANY. In +XmTOGGLE_BOOLEAN mode, the XmNset resource can only accept +XmSET and XmUNSET. + + + + +XmNunselectColor + +Allows the application to specify what color fills +the center of the square, diamond-shaped, or round indicator when it +is not set. +If this color is the same as either the top or the bottom shadow color of the +indicator, a one-pixel-wide margin is left between the shadows and the fill; +otherwise, it is filled completely. +This resource's default for a color display is XmNbackground. +For a monochrome display, the default is set to +the background color. To set the background of the button to +XmNunselectColor when XmNindicatorOn is +XmINDICATOR_NONE, the value of +XmNfillOnSelect must be explicitly set to True. This resource +acts like the XmNselectColor resource, but for the case when +XmNset is XmUNSET. + + + + +XmNvalueChangedCallback + +Specifies a list of callbacks +called when the ToggleButtonGadget value +is changed. To change the value, +press and release the active mouse button while the pointer +is inside the ToggleButtonGadget. This action +also causes the gadget to be disarmed. +For this callback, the reason is XmCR_VALUE_CHANGED. + + + + +XmNvisibleWhenOff + +Indicates that the toggle indicator is visible in the unselected state when +the Boolean value is True. +When the ToggleButtonGadget is in a menu, the default value is False. +When the ToggleButtonGadget is in a RadioBox, the default value is True. + + + + + + +Inherited Resources +ToggleButtonGadget inherits behavior and resources from the +superclasses described in the following tables. +For a complete description of each resource, refer to the +reference page for that superclass. + + + + + + + + + + + +XmLabelGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerator +XmCAccelerator +String +NULL +CSG + + +XmNacceleratorText +XmCAcceleratorText +XmString +NULL +CSG + + +XmNalignment +XmCAlignment +unsigned char +dynamic +CSG + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNlabelInsensitivePixmap +XmCLabelInsensitivePixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelPixmap +XmCLabelPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNlabelString +XmCXmString +XmString +dynamic +CSG + + +XmNlabelType +XmCLabelType +unsigned char +XmSTRING +CSG + + +XmNmarginBottom +XmCMarginBottom +Dimension +dynamic +CSG + + +XmNmarginHeight +XmCMarginHeight +Dimension +2 +CSG + + +XmNmarginLeft +XmCMarginLeft +Dimension +dynamic +CSG + + +XmNmarginRight +XmCMarginRight +Dimension +0 +CSG + + +XmNmarginTop +XmCMarginTop +Dimension +dynamic +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +2 +CSG + + +XmNmnemonic +XmCMnemonic +KeySym +NULL +CSG + + +XmNmnemonicCharSet +XmCMnemonicCharSet +String +dynamic +CSG + + +XmNrecomputeSize +XmCRecomputeSize +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNstringDirection +XmCStringDirection +XmStringDirection +dynamic +CSG + + + + + + + + + + + + + + +XmGadget Resource Set + + +Name +Class +Type +Default +Access + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + +XmNlayoutDirection +XmNCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmNONE +CSG + + +XmNshadowThickness +XmCShadowThickness +Dimension +dynamic +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +RectObj Resource Set + + +Name +Class +Type +Default +Access + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +N/A + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + + + + + + + + + +Object Resource Set + + +Name +Class +Type +Default +Access + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; + int set; +} XmToggleButtonCallbackStruct; + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + +set + +Reflects the ToggleButtonGadget's state, either +XmSET (selected), XmUNSET (unselected), or +XmINDETERMINATE (neither). +Note that the reported state is the state that the ToggleButtonGadget +is in after the event has been processed. For example, +suppose that a user clicks on a ToggleButtonGadget to change it from +the unselected state to the selected state. In this case, +ToggleButtonGadget changes the value of set from XmUNSET +to XmSET prior to calling the callback. + + + + + + + + + + + + + + + + +Behavior +XmToggleButtonGadget includes behavior from XmGadget. +XmToggleButtonGadget includes menu traversal behavior from XmLabelGadget. +Additional XmToggleButtonGadget behavior is described in the +following list: + + + +Btn2Down: + +Drags the contents of a ToggleButtonGadget label, identified when +Btn2 is pressed. +This action is undefined for ToggleButtonGadgets used in a menu system. + + + + +Btn1Down: + +In a menu, this action unposts any menus posted by the ToggleButtonGadget's +parent menu, +disables keyboard traversal for the menu, and enables mouse traversal +for the menu. +It draws the shadow in the armed state +and, unless the button is already armed, calls the XmNarmCallback +callbacks. + +Outside a menu, if the button was previously unset, this action does the +following: +if XmNindicatorOn is True, it draws the indicator shadow so that +the indicator looks pressed; if XmNfillOnSelect is True, it fills +the indicator with the color specified by XmNselectColor. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks pressed. +If XmNlabelType is XmPIXMAP, the XmNselectPixmap is +used as the button face. +This resource calls the XmNarmCallback callbacks. + +Outside a menu, if the button was previously set, this action does the +following: +if both XmNindicatorOn and XmNvisibleWhenOff are True, it +draws the indicator shadow so that the indicator looks raised; if +XmNfillOnSelect is True, it fills the indicator with the +background color. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks raised. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used as the button face. +This resource calls the XmNarmCallback callbacks. + + + + +Btn1Up: + +In a menu, this action +unposts all menus in the menu hierarchy. +If the ToggleButtonGadget was previously set, this action +unsets it; if the ToggleButtonGadget +was previously unset, this action sets it. +It calls the XmNvalueChangedCallback callbacks and then the +XmNdisarmCallback callbacks. + +If the button is outside a menu and the pointer is within the button, +this action does the following: +if the button was previously unset, sets it; if the button was +previously set, unsets it. +This action calls the XmNvalueChangedCallback callbacks. + +If the button is outside a menu, this action calls the XmNdisarmCallback +callbacks. + + + + +KeyosfHelp: + +In a Pulldown or Popup MenuPane, unposts all menus in the menu hierarchy +and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard focus to the widget that had the focus before +the menu system was entered. +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help callbacks for this widget, this action calls the +help callbacks for the nearest ancestor that has them. + + + + +KeyosfActivate: + +In a menu, this action unposts all menus in the menu hierarchy. +Unless the button is already armed, this action calls the XmNarmCallback +callbacks; and calls the XmNvalueChangedCallback and +XmNdisarmCallback callbacks. Outside a menu, +if the parent is a manager, this action passes the event to the parent. + + + + +KeyosfSelect: + +If the ToggleButtonGadget was previously set, this action unsets it; if the +ToggleButtonGadget was previously unset, this action sets it. + +In a menu, this action +unposts all menus in the menu hierarchy. +Unless the button is already armed, +this action calls the XmNarmCallback, +the XmNvalueChangedCallback, and +XmNdisarmCallback callbacks. + +Outside a menu, if the button was previously unset, this action does the +following: +If XmNindicatorOn is True, it draws the indicator shadow so that +the indicator looks pressed; if XmNfillOnSelect is True, it fills +the indicator with the color specified by XmNselectColor. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks pressed. +If XmNlabelType +is XmPIXMAP, the XmNselectPixmap is +used as the button face. +This action calls the XmNarmCallback, XmNvalueChangedCallback, +XmNdisarmCallback callbacks. + +Outside a menu, if the button was previously set, this action does the +following: +If both XmNindicatorOn and XmNvisibleWhenOff are True, it +draws the indicator shadow so that the indicator looks raised; if +XmNfillOnSelect is True, it fills the indicator with the +background color. +If XmNindicatorOn is False, it draws the button shadow so that the +button looks raised. +If XmNlabelType is XmPIXMAP, the XmNlabelPixmap is +used as the button face. +Calls the XmNarmCallback, XmNvalueChangedCallback, and +XmNdisarmCallback callbacks. + + + + +KeyosfCancel: + +In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, +disarms the MenuBar CascadeButton and the MenuBar, and, +when the shell's keyboard focus policy is +XmEXPLICIT, +restores keyboard +focus to the widget that had the focus before the MenuBar was +entered. +In other Pulldown MenuPanes, this action unposts the menu. +Outside a menu, if the parent is a manager, this action passes the event to the +parent. + +In a Popup MenuPane, this action unposts the menu and restores keyboard focus to the +widget from which the menu was posted. + + + + +Enter: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the armed state and calls the +XmNarmCallback callbacks. + +If the ToggleButtonGadget is not in a menu and the cursor leaves and then +reenters the ToggleButtonGadget while the button is pressed, this +action restores the button's armed appearance. + + + + +Leave: + +In a menu, if keyboard traversal is enabled, this action does nothing. +Otherwise, it draws the shadow in the unarmed state and calls the +XmNdisarmCallback callbacks. + +If the ToggleButtonGadget is not in a menu and the cursor leaves the +ToggleButtonGadget while the button is pressed, this action restores +the button's unarmed appearance. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Object;, +&cdeman.RectObj;, +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateToggleButtonGadget;, +&cdeman.XmGadget;, +&cdeman.XmLabelGadget;, +&cdeman.XmRowColumn;, +&cdeman.XmToggleButtonGadgetGetState;, and +&cdeman.XmToggleButtonGadgetSetState;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBC.sgm new file mode 100644 index 00000000..382a1311 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBC.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmToggleButtonGadgetGetState +library call + + +XmToggleButtonGadgetGetState +A ToggleButtonGadget function that obtains the state of a ToggleButtonGadget + +XmToggleButtonGadgetGet\\%State + +ToggleButtonGadget functions +XmToggleButtonGadgetGet\\%State + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleBG.h> + +Boolean XmToggleButtonGadgetGetState + +Widget widget + + + +DESCRIPTION +XmToggleButtonGadgetGetState obtains the state of a ToggleButtonGadget. + + + +widget + +Specifies the ToggleButtonGadget ID + + + + +For a complete definition of ToggleButtonGadget and +its associated resources, see &cdeman.XmToggleButtonGadget;. + + + +RETURN +Returns True if the button is selected and False if the button is +unselected. + + + +RELATED +&cdeman.XmToggleButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBD.sgm new file mode 100644 index 00000000..24348902 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBD.sgm @@ -0,0 +1,103 @@ + + + + + + + + + + + +XmToggleButtonGadgetSetState +library call + + +XmToggleButtonGadgetSetState +A ToggleButtonGadget function that sets or changes the current state + +XmToggleButtonGadgetSet\\%State + +ToggleButtonGadget functions +XmToggleButtonGadgetSet\\%State + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleBG.h> + +void XmToggleButtonGadgetSetState + +Widget widget +Boolean state +Boolean notify + + + +DESCRIPTION +XmToggleButtonGadgetSetState sets or changes the ToggleButtonGadget's +current state. + + + +widget + +Specifies the ToggleButtonGadget widget ID. + + + + +state + +Specifies a Boolean value that indicates whether the ToggleButtonGadget state is +selected or unselected. If the value is True, the button state is selected; +if it is False, the button state is unselected. + + + + +notify + +Indicates whether XmNvalueChangedCallback is called; +it can be either True or False. +The XmNvalueChangedCallback is only called when this function +changes the state of the ToggleButtonGadget. +When this argument is True and the ToggleButtonGadget is a child of a +RowColumn widget whose XmNradioBehavior is True, setting the +ToggleButtonGadget causes other ToggleButton and ToggleButtonGadget +children of the RowColumn to be unselected. + + + + +For a complete definition of ToggleButtonGadget and +its associated resources, see &cdeman.XmToggleButtonGadget;. + + + +RELATED +&cdeman.XmToggleButtonGadget;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBE.sgm new file mode 100644 index 00000000..c2b754eb --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBE.sgm @@ -0,0 +1,82 @@ + + + + + + + + + + + +XmToggleButtonGetState +library call + + +XmToggleButtonGetState +A ToggleButton function that obtains the state of a ToggleButton + +XmToggleButtonGetState + +ToggleButton functions +XmToggleButtonGetState + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleB.h> + +Boolean XmToggleButtonGetState + +Widget widget + + + +DESCRIPTION +XmToggleButtonGetState obtains the state of a ToggleButton. + + + +widget + +Specifies the ToggleButton widget ID + + + + +For a complete definition of ToggleButton and +its associated resources, see &cdeman.XmToggleButton;. + + + +RETURN +Returns True if the button is selected and False if the button is unselected. + + + +RELATED +&cdeman.XmToggleButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBF.sgm new file mode 100644 index 00000000..8e350ed4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBF.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmToggleButtonSetState +library call + + +XmToggleButtonSetState +A ToggleButton function that sets or changes the current state + +XmToggleButtonSetState + +ToggleButton functions +XmToggleButtonSetState + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/ToggleB.h> + +void XmToggleButtonSetState + +Widget widget +Boolean state +Boolean notify + + + +DESCRIPTION +XmToggleButtonSetState sets or changes the ToggleButton's current state. + + + +widget + +Specifies the ToggleButton widget ID. + + + + +state + +Specifies a Boolean value that indicates whether the ToggleButton state is +selected or unselected. If the value is True, the button state is selected; +if it is False, the button state is unselected. + + + + +notify + +Indicates whether XmNvalueChangedCallback is called; +it can be either True or False. +The XmNvalueChangedCallback is only called when this function +changes the state of the ToggleButton. +When this argument is True and the ToggleButton is a child of a +RowColumn widget whose XmNradioBehavior is True, setting the +ToggleButton causes other ToggleButton and ToggleButtonGadget +children of the RowColumn to be unselected. + + + + +For a complete definition of ToggleButton and +its associated resources, see &cdeman.XmToggleButton;. + + + +RELATED +&cdeman.XmToggleButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBG.sgm new file mode 100644 index 00000000..3f6012bd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/ToggleBG.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmToggleButtonSetValue +library call + + +XmToggleButtonSetValue +A ToggleButton function that sets or changes the current state + +XmToggleButtonSetValue + +ToggleButton functions +XmToggleButtonSetValue + + + + + + + + + + + +#include <Xm/ToggleB.h> + +void XmToggleButtonSetValue + +Widget widget +XmToggleButtonState state +Boolean notify + + + +DESCRIPTION +XmToggleButtonSetValue sets or changes the ToggleButton's current state. + + + +widget + +Specifies the ToggleButton widget ID. + + + + +state + +Specifies whether the ToggleButton state is +selected or unselected. If the value is True, the button state is selected; +if it is False, the button state is unselected, if it is +XmINDETERMINATE, the button state is neither. + + + + +notify + +Indicates whether XmNvalueChangedCallback is called; +it can be either True or False. +The XmNvalueChangedCallback is only called when this function +changes the state of the ToggleButton. +When this argument is True and the ToggleButton is a child of a +RowColumn widget whose XmNradioBehavior is True, setting the +ToggleButton causes other ToggleButton and ToggleButtonGadget +children of the RowColumn to be unselected. + + + + +For a complete definition of ToggleButton and +its associated resources, see &cdeman.XmToggleButton;. + + + +RELATED +&cdeman.XmToggleButton;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackE.sgm new file mode 100644 index 00000000..a7d07c08 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackE.sgm @@ -0,0 +1,119 @@ + + + + + + + + + + + +XmTrackingEvent +library call + + +XmTrackingEvent +A Toolkit function that provides a modal interaction + +XmTrackingEvent + +Toolkit functions +XmTrackingEvent + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmTrackingEvent + +Widget widget +Cursor cursor +Boolean confine_to +XEvent *event_return + + + +DESCRIPTION +XmTrackingEvent provides a modal interface for selection of a +component. +It is intended to support context help. +The function +calls the XmUpdateDisplay function. +XmTrackingEvent then grabs +the pointer and discards succeeding events until +BSelect is released or a key is pressed and then released. +The function then returns the widget or gadget that contains the +pointer when BSelect is released or a key is +released, and ungrabs the pointer. + + + +widget + +Specifies the widget ID of a widget to use as the basis of the modal +interaction. That is, the widget within which the interaction must +occur, usually a top-level shell. + + + + +cursor + +Specifies the cursor to be used for the pointer during the interaction. +This is a standard X cursor name. + + + + +confine_to + +Specifies whether or not the cursor should be confined to widget. + + + + +event_return + +Returns the ButtonRelease or KeyRelease event that causes the function +to return. + + + + + + +RETURN +Returns the widget or gadget that contains the pointer when BSelect +is released or a key is released. If no widget or gadget contains the +pointer, the function returns NULL. + + + +RELATED +&cdeman.XmTrackingLocate;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackL.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackL.sgm new file mode 100644 index 00000000..4cb975ea --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TrackL.sgm @@ -0,0 +1,106 @@ + + + + + + + + + + + +XmTrackingLocate +library call + + +XmTrackingLocate +A Toolkit function that provides a modal interaction + +XmTrackingLocate + +Toolkit functions +XmTrackingLocate + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Widget XmTrackingLocate + +Widget widget +Cursor cursor +Boolean confine_to + + + +DESCRIPTION +XmTrackingLocate provides a modal interface for selection of a +component. +It is intended to support context help. +This function is implemented as XmTrackingEvent. + +NOTE: This function is obsolete and exists for compatibility with +previous releases. It has been replaced by XmTrackingEvent. + + + +widget + +Specifies the widget ID of a widget to use as the basis of the modal +interaction. That is, the widget within which the interaction must +occur, usually a top-level shell. + + + + +cursor + +Specifies the cursor to be used for the pointer during the interaction. +This is a standard X cursor name. + + + + +confine_to + +Specifies whether or not the cursor should be confined to widget + + + + + + +RETURN +Returns the widget or gadget that contains the pointer when BSelect +is released or a key is released. If no widget or gadget contains the +pointer, the function returns NULL. + + + +RELATED +&cdeman.XmTrackingEvent;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfA.sgm new file mode 100644 index 00000000..95baee79 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfA.sgm @@ -0,0 +1,171 @@ + + + + + + + + + + + +XmTransferDone +library call + + +XmTransferDone +A toolkit function that completes a data transfer + +XmTransferDone + +toolkit functions +XmTransferDone + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTransferDone + +XtPointer transfer_id +XmTransferStatus status + + + +DESCRIPTION +XmTransferDone completes an already-initiated data transfer +operation. +An application can call this routine from an +XmNdestinationCallback procedure or any function called as a +result, including the selection procedures called as a result of calls +to XmTransferValue. + +The caller of XmTransferDone supplies an identifier for the +transfer operation and an indication of the completion status. +XmTransferDone causes any remaining transfers for the operation to +be discarded. + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. +The value must be the same as the value of the transfer_id member +of the XmDestinationCallbackStruct passed to the +XmNdestinationCallback procedure. + + + + +status + +Specifies the completion status of the data transfer. +Following are the possible values: + + + +XmTRANSFER_DONE_SUCCEED + +The transfer was completed successfully. +This status has the following additional effects: + + + +For a move operation, the selection owner receives a request to convert +the selection to the DELETE target. + + + +If a TRANSACT operation is in progress, the owner receives a +request to commit the transaction. + + + +If a PERSIST or _MOTIF_SNAPSHOT operation is in progress, +the owner receives a notification that the operation is finished. + + + +The widget class destination procedure is not called. + + + + + + +XmTRANSFER_DONE_FAIL + +The transfer was completed unsuccessfully. +This status has the following additional effects: + + + +For a move operation, the selection owner does not receive a request to +convert the selection to the DELETE target. + + + +For a drag and drop operation, the DropTransfer's +XmNtransferStatus is set to XmTRANSFER_FAILURE. + + + +If a TRANSACT operation is in progress, the owner receives a +request to abort the transaction. + + + +If a PERSIST or _MOTIF_SNAPSHOT operation is in +progress, the owner receives a notification that the operation +is finished. + + + +The widget class destination procedure is not called. + + + + + + +XmTRANSFER_DONE_CONTINUE + +This status has the same effect as XmTRANSFER_DONE_SUCCEED, except +that if a PERSIST or _MOTIF_SNAPSHOT operation is +in progress, the +owner does not receive a notification that the operation is finished. + + + + +XmTRANSFER_DONE_DEFAULT + +The widget class destination procedure is called. +Further effects depend on the actions of that procedure. + + + + + + + + + +RELATED +&cdeman.XmTransferSendRequest;, +&cdeman.XmTransferStartRequest;, +&cdeman.XmTransferStartRequest;, +and +&cdeman.XmTransferValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfB.sgm new file mode 100644 index 00000000..5a2ff2cc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfB.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + + +XmTransferSendRequest +library call + + +XmTransferSendRequest +A toolkit function that transfers a MULTIPLE request + +XmTransferSendRequest + +toolkit functions +XmTransferSendRequest + + + + + + + + + + + +#include <Xm/Transfer.h> + +void XmTransferSendRequest + +XtPointer transfer_id +Time time + + + +DESCRIPTION +XmTransferSendRequest marks the end of a MULTIPLE request +started by XmTransferStartRequest. + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. + + + + +time + +Specifies the time of the XEvent that triggered the data transfer. +You should typically set this field to XtLastTimestampProcessed. + + + + + + +RELATED +&cdeman.XmTransferSetParameters;, +&cdeman.XmTransferStartRequest;, +and +&cdeman.XmTransferValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfC.sgm new file mode 100644 index 00000000..e424de7b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfC.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmTransferSetParameters +library call + + +XmTransferSetParameters +A toolkit function that establishes parameters to be passed by the next call to XmTransferValue + +XmTransferSetParameters + +toolkit functions +XmTransferSetParameters + + + + + + + + + + + +#include <Xm/Transfer.h> + +void XmTransferSetParameters + +XtPointer transfer_id +XtPointer parm +int parm_fmt +unsigned long parm_length +Atom parm_type + + + +DESCRIPTION +XmTransferSetParameters establishes a parameter definition. +Your application calls XmTransferSetParameters just before calling +XmTransferValue, and only if XmTransferValue needs +to transfer a value containing a parameter. + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. +The value must be the same as the value of the transfer_id member +of the XmDestinationCallbackStruct passed to the +XmNdestinationCallback procedure. + + + + +parm + +Specifies parameters to be passed to the conversion routine (and the +XmNconvertCallback procedures, if any) of the widget that owns the +selection. +The type and length of parameters are target-specific. +If the target takes no parameters, the value is NULL. + + + + +parm_fmt + +Specifies whether the data in parm should be viewed as a list of +8-bit, 16-bit, or 32-bit quantities. +Possible values are 0 (when parm is NULL), 8, 16, and 32. + + + + +parm_length + +Specifies the number of elements of data in parm, where each +element has the number of bits specified by parm_fmt. +When parm is NULL, the value is 0. + + + + +parm_type + +Specifies the type of parm. + + + + + + +RELATED +&cdeman.XmTransferSendRequest;, +&cdeman.XmTransferStartRequest;, and +&cdeman.XmTransferValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfD.sgm new file mode 100644 index 00000000..928664b2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfD.sgm @@ -0,0 +1,72 @@ + + + + + + + + + + + +XmTransferStartRequest +library call + + +XmTransferStartRequest +A toolkit function that begins a MULTIPLE transfer + +XmTransferStartRequest + +toolkit functions +XmTransferStartRequest + + + + + + + + + + + +#include <Xm/Transfer.h> + +void XmTransferStartRequest + +XtPointer transfer_id + + + +DESCRIPTION +XmTransferStartRequest begins a MULTIPLE request. +The MULTIPLE request may contain one or more calls to +XmTransferValue. Your application concludes a +MULTIPLE request by calling XmTransferSendRequest. + +XmTransferStartRequest is typically called by a destination callback +or by a transfer procedure. + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. +You should use the transfer_id passed in the +XmDestinationCallbackStruct or XmSelectionCallbackStruct. + + + + + + +RELATED +&cdeman.XmTransferSetParameters;, +&cdeman.XmTransferSendRequest;, +and +&cdeman.XmTransferValue;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfV.sgm new file mode 100644 index 00000000..7b2590b2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TransfV.sgm @@ -0,0 +1,251 @@ + + + + + + + + + + + +XmTransferValue +library call + + +XmTransferValue +A toolkit function that transfers data to a destination + +XmTransferValue + +toolkit functions +XmTransferValue + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTransferValue + +XtPointer transfer_id +Atom target +XtCallbackProc proc +XtPointer client_data +Time time + + + +DESCRIPTION +XmTransferValue converts a selection, transferring any data from +the selection owner, in the context of an already-initiated data +transfer operation. +An application can call this routine from an +XmNdestinationCallback procedure or any function called as a +result. + +The caller of XmTransferValue supplies the target to which the +selection is converted. +The caller also supplies a callback procedure to handle the data that +results from the conversion. + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. +The value must be the same as the value of the transfer_id member +of the XmDestinationCallbackStruct passed to the +XmNdestinationCallback procedure. + + + + +target + +Specifies the target to which the selection is to be converted. + + + + +proc + +Specifies a callback procedure to be invoked when the selection has been +converted and the data, if any, is available. +This procedure is responsible for inserting or otherwise handling any +data transferred. +The procedure can also terminate the data transfer by calling +XmTransferDone. +The proc receives three arguments: + + + +The widget that requested the conversion + + + +The value of the client_data argument + + + +A pointer to an XmSelectionCallbackStruct + + + +This procedure can be called before or after XmTransferValue +returns. + + + + +client_data + +Specifies data to be passed to the callback procedure (the value of the +proc argument) when the selection has been converted. + + + + +time + +Specifies the time of the XEvent that triggered the data transfer. +You should typically set this field to XtLastTimestampProcessed. + + + + +The callback procedure (the value of the proc argument) receives a +pointer to an XmSelectionCallbackStruct, which has the following +definition: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + Atom target; + Atom type; + XtPointer transfer_id; + int flags; + int remaining; + XtPointer value; + unsigned long length; + int format; +} XmSelectionCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Specifies the selection that has been converted. + + + + +target + +Specifies the target to which XmTransferValue requested +conversion. +The value is the same as the value of the target argument to +XmTransferValue. + + + + +type + +Specifies the type of the selection value. +This is not the target, but the type used to represent the target. +The value XT_CONVERT_FAIL means that the selection owner did not +respond to the conversion request within the Intrinsics selection +timeout interval. + + + + +transfer_id + +Specifies a unique indentifier for the data transfer operation. +The value is the same as the value of the transfer_id argument to +XmTransferValue. + + + + +flags + +This member is currently unused. +The value is always XmSELECTION_DEFAULT. + + + + +remaining + +Indicates the number of transfers remaining for the operation specified +by transfer_id. + + + + +value + +Represents the data transferred by this request. +The application is responsible for freeing the value by calling +XtFree. + + + + +length + +Indicates the number of elements of data in +value, where each element has the size symbolized by format. +If value is NULL, length is 0. + + + + +format + +Indicates whether the data in value should be viewed as a list of +char, short, or long quantities. +Possible values are 8 (for a list of char), +16 (for a list of short), or 32 (for a list of long). + + + + + + +RELATED +&cdeman.XmTransferSetParameters;, +&cdeman.XmTransferSendRequest;, +and +&cdeman.XmTransferStartRequest;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Translat.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Translat.sgm new file mode 100644 index 00000000..eebbc46f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Translat.sgm @@ -0,0 +1,114 @@ + + + + + + + + + + + +XmTranslateKey +library call + + +XmTranslateKey +The default keycode-to-keysym translator + +XmTranslateKey + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +void XmTranslateKey + +Display *display +KeyCode keycode +Modifiers modifiers +Modifiers *modifiers_return +KeySym *keysym_return + + + +DESCRIPTION +XmTranslateKey is the default XtKeyProc translation +procedure for Motif applications. The function takes a keycode +and modifiers and returns the corresponding keysym. + +XmTranslateKey serves two main purposes: to enable new translators +with expanded functionality to get the default +Motif keycode-to-keysym translation in addition to whatever they add, +and to reinstall the default translator. This function enables +keysyms defined by the Motif virtual bindings to be used when an +application requires its own XtKeyProc to be installed. + + + +display + +Specifies the display that the keycode is from + + + + +keycode + +Specifies the keycode to translate + + + + +modifiers + +Specifies the modifier keys to be applied to the keycode + + + + +modifiers_return + +Specifies a mask of the modifier keys actually used to generate +the keysym (an AND of modifiers and any default modifiers +applied by the currently registered translator) + + + + +keysym_return + +Specifies a pointer to the resulting keysym + + + + + + +RELATED +&cdeman.VirtualBindings;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtClear.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtClear.sgm new file mode 100644 index 00000000..7e3ef7b4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtClear.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmTextClearSelection +library call + + +XmTextClearSelection +A Text function that clears the primary selection + +XmTextClearSelection + +Text functions +XmTextClearSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextClearSelection + +Widget widget +Time time + + + +DESCRIPTION +XmTextClearSelection clears the primary selection in the Text widget. + + + +widget + +Specifies the Text widget ID. + + + + +time + +Specifies the server time at which the selection value is desired. This +should be the time of the event that triggered this request. +One source of a valid time stamp is the function XtLastTimestampProcessed(). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopy.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopy.sgm new file mode 100644 index 00000000..bd9816ec --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopy.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmTextCopy +library call + + +XmTextCopy +A Text function that copies the primary selection to the clipboard + +XmTextCopy + +Text functions +XmTextCopy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextCopy + +Widget widget +Time time + + + +DESCRIPTION +XmTextCopy copies the primary selected text to the clipboard. + +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmCOPY. + + + +widget + +Specifies the Text widget ID. + + + + +time + +Specifies the server time at which the selection value is to be modified. This +should be the time of the event which triggered this request. +One source of a valid time stamp is the function XtLastTimestampProcessed(). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN + +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopyL.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopyL.sgm new file mode 100644 index 00000000..50c6817b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCopyL.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmTextCopyLink +library call + + +XmTextCopyLink +A Text function that copies a link to the primary selection to the clipboard + +XmTextCopyLink + +Text functions +XmTextCopyLink + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextCopyLink + +Widget widget +Time time + + + +DESCRIPTION +XmTextCopyLink copies a link to the primary selected text to the +clipboard. +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmLINK. +The Text widget itself does not copy any links; XmNconvertCallback +procedures are responsible for copying the link to the clipboard and for +taking any related actions. + + + +widget + +Specifies the Text widget ID. + + + + +time + +Specifies the time of the transfer. +This should be the time of the event which triggered this request. +One source of a valid time stamp is the function +XtLastTimestampProcessed. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCut.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCut.sgm new file mode 100644 index 00000000..5929c155 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtCut.sgm @@ -0,0 +1,112 @@ + + + + + + + + + + + +XmTextCut +library call + + +XmTextCut +A Text function that copies the primary selection to the clipboard and deletes the selected text + +XmTextCut + +Text functions +XmTextCut + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextCut + +Widget widget +Time time + + + +DESCRIPTION +XmTextCut copies the primary selected text to the clipboard and +then deletes the primary selected text. +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. + +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmMOVE. +If the transfer is successful, this routine then calls the +XmNconvertCallback procedures for the CLIPBOARD selection +and the DELETE target. + + + +widget + +Specifies the Text widget ID. + + + + +time + +Specifies the server time at which the selection value is to be modified. This +should be the time of the event that triggered this request. +One source of a valid time stamp is the function XtLastTimestampProcessed(). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN + +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtDisab.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtDisab.sgm new file mode 100644 index 00000000..2bcdfa2a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtDisab.sgm @@ -0,0 +1,81 @@ + + + + + + + + + + + +XmTextDisableRedisplay +library call + + +XmTextDisableRedisplay +A Text function that temporarily +prevents visual update of the Text widget + +XmTextDisableRedisplay + +Text functions +XmTextDisableRedisplay + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextDisableRedisplay + +Widget widget + + + +DESCRIPTION +XmTextDisableRedisplay prevents redisplay of the specified +Text widget even though its visual attributes have been +modified. The visual appearance of the widget remains +unchanged until XmTextEnableRedisplay is called, +although the insertion cursor is not displayed. +This allows an application to make multiple changes to +the widget without causing intermediate visual updates. + + + +widget + +Specifies the Text widget ID + + + + + + +RELATED +&cdeman.XmTextEnableRedisplay;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtEnabl.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtEnabl.sgm new file mode 100644 index 00000000..8f1365a5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtEnabl.sgm @@ -0,0 +1,84 @@ + + + + + + + + + + + +XmTextEnableRedisplay +library call + + +XmTextEnableRedisplay +A Text function that forces the +visual update of a Text widget + +XmTextEnableRedisplay + +Text functions +XmTextEnableRedisplay + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextEnableRedisplay + +Widget widget + + + +DESCRIPTION +XmTextEnableRedisplay is used in conjunction with +XmTextDisableRedisplay, which suppresses visual update +of the Text widget. When XmTextEnableRedisplay is +called, it determines if any visual attributes have been set +or modified for the specified widget since XmTextDisableRedisplay +was called. If so, it forces the widget to update its visual display for +all of the intervening changes. Any subsequent changes that affect +visual appearance cause the widget to update its visual display. +This function also causes the insertion cursor, which is not shown +while redisplay is disabled, to be restored. + + + +widget + +Specifies the Text widget ID + + + + + + +RELATED +&cdeman.XmTextDisableRedisplay;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAA.sgm new file mode 100644 index 00000000..53f97101 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAA.sgm @@ -0,0 +1,3336 @@ + + + + + + + + + + +XmTextField +library call + + +XmTextField +The TextField class + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + + + +DESCRIPTION +The TextField widget provides a single line text editor for customizing +both user and programmatic interfaces. It is used for single-line +string entry, and forms entry with verification procedures. +It provides an application with a consistent editing system for +textual data. + +TextField provides separate callback lists to verify +movement of the insert cursor, modification of the text, and +changes in input focus. Each of +these callbacks provides the verification function with the +widget instance, the event that caused the callback, and a +data structure specific to the verification type. From this +information, the function can verify if the application considers +this to be a legitimate state change and can signal the widget +whether to continue with the action. + +The user interface tailors a new set of actions. +The key bindings have been added for insert cursor movement, deletion, +insertion, and selection of text. + +TextField allows the user to select regions of text. +Selection is based on the model specified in the Inter-Client +Communication Conventions Manual (ICCCM). +TextField supports primary and secondary selection. + +TextField uses the XmQTnavigator, XmQTspecifyRenderTable, and +XmQTscrollFrame traits, +and holds the XmQTaccessTextual +XmQTtransfer traits. + +If an application or widget calls the setValue trait method +of XmQTaccessTextual, then XmTextField will call +XmTextFieldSetString to set the string value. + + +Data Transfer Behavior +TextField supports transfer of the primary, secondary, and clipboard +selections and dragging of selected text from the widget. +TextField can also be the destination for the primary, secondary, and +clipboard selections, and it supports dropping of data being dragged +onto the widget. + +When the XmNconvertCallback procedures are called, the +location_data member of the XmConvertCallbackStruct member +is NULL if the selected text is being transferred. +If the entire text, not the selected text, is being transferred, the +value of this member is the widget ID of the TextField widget. + +As a source of data, TextField supports the following targets and +associated conversions of data to these targets: + + + +locale + +If the locale target matches the widget's locale, the widget +transfers the selected text in the encoding of the locale. + + + + +COMPOUND_TEXT + +The widget transfers the selected text as type COMPOUND_TEXT. + + + + +STRING + +The widget transfers the selected text as type STRING. + + + + +TEXT + +If the selected text is fully convertible to the encoding of the locale, +the widget transfers the selected text in the encoding of the locale. +Otherwise, the widget transfers the selected text as type +COMPOUND_TEXT. + + + + +DELETE + +The widget deletes the selected text. + + + + +_MOTIF_CLIPBOARD_TARGETS + +The widget transfers, as type ATOM, a list of the targets to which +the widget can convert data to be placed on the clipboard immediately. +These include the following targets: + + + +COMPOUND_TEXT + + + +The encoding of the locale, if the selected text is fully convertible to +the encoding of the locale + + + +STRING, if the selected text is fully convertible to STRING + + + + + + +_MOTIF_EXPORT_TARGETS + +The widget transfers, as type ATOM, a list of the targets to be +used as the value of the DragContext's XmNexportTargets in a +drag-and-drop transfer. +These include COMPOUND_TEXT, the encoding of the locale, +STRING, TEXT, BACKGROUND, and FOREGROUND. + + + + +_MOTIF_LOSE_SELECTION + +The widget takes the following actions: + + + +When losing the PRIMARY selection, it unhighlights the selected +text and calls the XmNlosePrimaryCallback procedures. + + + +When losing the SECONDARY selection, it removes the secondary +selection highlight. + + + +When losing the _MOTIF_DESTINATION selection, if the widget does +not have focus it changes the cursor to indicate that the widget is no +longer the destination. + + + + + + +As a source of data, TextField also supports the following standard +Motif targets: + + + +BACKGROUND + +The widget transfers XmNbackground as type PIXEL. + + + + +CLASS + +The widget finds the first shell in the widget hierarchy that has a +WM_CLASS property and transfers the contents as text in the +current locale. + + + + +CLIENT_WINDOW + +The widget finds the first shell in the widget hierarchy and transfers +its window as type WINDOW. + + + + +COLORMAP + +The widget transfers XmNcolormap as type COLORMAP. + + + + +FOREGROUND + +The widget transfers XmNforeground as type PIXEL. + + + + +NAME + +The widget finds the first shell in the widget hierarchy that has a +WM_NAME property and transfers the contents as text in the current +locale. + + + + +TARGETS + +The widget transfers, as type ATOM, a list of the targets it +supports. +These include the standard targets in this list. +These also include COMPOUND_TEXT, the encoding of the locale, +STRING, and TEXT. + + + + +TIMESTAMP + +The widget transfers the timestamp used to acquire the selection as type +INTEGER. + + + + +_MOTIF_RENDER_TABLE + +The widget transfers XmNrenderTable if it exists, or else the +default text render table, as type STRING. + + + + +_MOTIF_ENCODING_REGISTRY + +The widget transfers its encoding registry as type STRING. +The value is a list of NULL separated items in the +form of tag encoding pairs. +This target symbolizes the transfer target for the +Motif Segment Encoding Registry. +Widgets and applications can use this Registry to register +text encoding formats for specified render table tags. +Applications access this Registry by calling +XmRegisterSegmentEncoding and XmMapSegmentEncoding. + + + + +As a destination for data, TextField chooses a target and requests +conversion of the selection to that target. +If the encoding of the locale is present in the list of available +targets, TextField chooses a requested target from the available targets +in the following order of preference: + + + +TEXT + + + +COMPOUND_TEXT + + + +The encoding of the locale + + + +STRING + + + +If the encoding of the locale is not present in the list of available +targets, TextField chooses a requested target from the available targets +in the following order of preference: + + + +COMPOUND_TEXT + + + +STRING + + + + + +Classes +TextField widget inherits behavior, resources, and traits from Core +and Primitive. + +The class pointer is xmTextFieldWidgetClass. + +The class name is XmTextField. + + + +New Resources +The following table defines a set of widget resources used by the programmer +to specify data. The programmer can also set the resource values for the +inherited classes to set attributes for this widget. To reference a +resource by name or by class in a .Xdefaults file, remove the XmN or +XmC prefix and use the remaining letters. To specify one of the defined +values for a resource in a .Xdefaults file, remove the Xm prefix and use +the remaining letters (in either lower case or upper case, but include any +underscores between words). +The codes in the access column indicate if the given resource can be +set at creation time (C), +set by using XtSetValues (S), +retrieved by using XtGetValues (G), +or is not applicable (N/A). + + + + + + + + + + + +XmTextFieldResource Set + + +Name +Class +Type +Default +Access + + +XmNactivateCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNblinkRate +XmCBlinkRate +int +500 +CSG + + +XmNcolumns +XmCColumns +short +dynamic +CSG + + +XmNcursorPosition +XmCCursorPosition +XmTextPosition +0 +CSG + + +XmNcursorPositionVisible +XmCCursorPositionVisible +Boolean +dynamic +CSG + + +XmNdestinationCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNeditable +XmCEditable +Boolean +True +CSG + + +XmNfocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNfontList +XmCFontList +XmFontList +dynamic +CSG + + +XmNgainPrimaryCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlosePrimaryCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNlosingFocusCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmarginHeight +XmCMarginHeight +Dimension +5 +CSG + + +XmNmarginWidth +XmCMarginWidth +Dimension +5 +CSG + + +XmNmaxLength +XmCMaxLength +int +largest integer +CSG + + +XmNmodifyVerifyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNmodifyVerifyCallbackWcs +XmCCallback +XtCallbackList +NULL +C + + +XmNmotionVerifyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNpendingDelete +XmCPendingDelete +Boolean +True +CSG + + +XmNrenderTable +XmCRenderTable +XmRenderTable +dynamic +CSG + + +XmNresizeWidth +XmCResizeWidth +Boolean +False +CSG + + +XmNselectionArray +XmCSelectionArray +XtPointer +default array +CSG + + +XmNselectionArrayCount +XmCSelectionArrayCount +int +3 +CSG + + +XmNselectThreshold +XmCSelectThreshold +int +5 +CSG + + +XmNvalue +XmCValue +String +"" +CSG + + +XmNvalueChangedCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNvalueWcs +XmCValueWcs +wchar_t * +(wchar_t *)"" +CSG1 + + +XmNverifyBell +XmCVerifyBell +Boolean +dynamic +CSG + + + + +1 This resource cannot be specified in a resource file. + + + +XmNactivateCallback + +Specifies the list of callbacks that is called when the user invokes an +event that calls the +activate() action. +The type of the structure whose address is passed to this callback is +XmAnyCallbackStruct. +The reason sent by the callback is XmCR_ACTIVATE. + + + + +XmNblinkRate + +Specifies the blink rate of the text cursor in milliseconds. +The time indicated in the blink rate relates to the +length of time the cursor is visible and the time the +cursor is invisible (that is, the time it will take to blink +the insertion cursor on and off will be two times the blink +rate). The cursor will not blink when the blink rate +is set to 0 (zero). +The value must not be negative. + + + + +XmNcolumns + +Specifies the initial width of the text window as an integer number of +characters. The width equals the number of characters specified by +this resource multiplied by the width as derived from the specified +font. If the em-space +value is available, +it is used. If not, the width of the numeral "0" is used. If this is +not available, the maximum width is used. +For proportionate fonts, the actual number of characters that fit +on a given line may be greater than the value specified. + + + + +XmNcursorPosition + +Indicates the position in the text where the current insert cursor is to +be located. Position is determined by the number of characters from +the beginning of the text. + + + + +XmNcursorPositionVisible + +If the text widget has an XmPrintShell as one of its ancestors +(that is, the widget was created on a print server connection) +then the default value is +False; otherwise, it is True. + + + + +XmNdestinationCallback + +Specifies a list of callbacks called when the widget is the destination +of a transfer operation. +The type of the structure whose address is passed to these callbacks is +XmDestinationCallbackStruct. +The reason is XmCR_OK. + + + + +XmNeditable + +When set to True, indicates that the user can edit the text string. +A false value will prohibit the user from editing the text. + + +When XmNeditable is used on a widget +it sets the dropsite to XmDROP_SITE_ACTIVE. + + + + +XmNfocusCallback + +Specifies the list of callbacks called when TextField accepts +input focus. The type of the structure whose address is passed to this +callback is XmAnyCallbackStruct. The reason sent by the +callback is XmCR_FOCUS. + + + + +XmNfontList + +Specifies the font list to be used for TextField. The font list is an +obsolete structure, and is retained only for compatibility with +earlier releases of Motif. Use the render table (XmNrenderTable) +instead of font lists wherever possible. If both are specified, the +render table will take precedence. If this value is NULL at +initialization, the parent hierarchy of the widget is searched for an +ancestor that holds the XmQTspecifyRenderTable trait. If such +an ancestor is found, the font list is initialized to the +XmTEXT_RENDER_TABLE value of the ancestor widget. If no such +ancestor is found, the default is implementation dependent. + +TextField searches the font list for the first occurrence of a font +set that has an XmFONTLIST_DEFAULT_TAG. If a default element is +not found, the first font set in the font list is used. If the list +contains no font sets, the first font in the font list will be used. +Refer to &cdeman.XmFontList; for more information on a font list +structure. + + + + +XmNgainPrimaryCallback + +Specifies the list of callbacks that are called when the user invokes +an event that causes the text widget to gain ownership of the primary +selection. The callback reason for this callback is XmCR_GAIN_PRIMARY. + + + + +XmNlosePrimaryCallback + +Specifies the list of callbacks that are called when the user invokes +an event that cause the text widget to lose ownership of the primary +selection. The callback reason for this callback is XmCR_LOSE_PRIMARY. + + + + +XmNlosingFocusCallback + +Specifies the list of callbacks that are called +before TextField widget loses input focus. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_LOSING_FOCUS. + + + + +XmNmarginHeight + +Specifies the distance between the top edge of the widget +window and the text, and the bottom edge of the widget +window and the text. + + + + +XmNmarginWidth + +Specifies the distance between the left edge of the widget +window and the text, and the right edge of the widget +window and the text. + + + + +XmNmaxLength + +Specifies the maximum length of the text string that can be entered into +text from the keyboard. +This value must be nonnegative. +Strings that are entered using the XmNvalue resource or the +XmTextFieldSetString function ignore this resource. + + + + +XmNmodifyVerifyCallback + +Specifies the list of callbacks that is called +before text is deleted from or inserted into +TextField. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_MODIFYING_TEXT_VALUE. +When multiple TextField widgets share the same +source, only the widget that initiates the source change will +generate the XmNmodifyVerifyCallback. + +If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs +are registered callback lists, the procedure(s) in the +XmNmodifyVerifyCallback list is always executed first; and the +resulting data, which may have been modified, is passed to the +XmNmodifyVerifyCallbackWcs callback routines. + + + + +XmNmodifyVerifyCallbackWcs + +Specifies the list of callbacks called before text is deleted from +or inserted into Text. The type of the structure whose address is +passed to this callback is XmTextVerifyCallbackStructWcs. The +reason sent by the callback is XmCR_MODIFYING_TEXT_VALUE. +When multiple TextField widgets share the same +source, only the widget that initiates the source change will +generate the XmNmodifyVerifyCallbackWcs. + +If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs +are registered callback lists, the procedure(s) in the +XmNmodifyVerifyCallback list is always executed first; and the +resulting data, which may have been modified, is passed to the +XmNmodifyVerifyCallbackWcs callback routines. + + + + +XmNmotionVerifyCallback + +Specifies the list of callbacks that is called +before the insert cursor is moved to a new position. +The type of the structure whose address is passed to this callback is +XmTextVerifyCallbackStruct. +The reason sent by the callback is XmCR_MOVING_INSERT_CURSOR. +It is possible for more than one XmNmotionVerifyCallbacks to be +generated from a single action. + + + + +XmNpendingDelete + +Indicates that pending delete mode is on when the Boolean is True. +Pending deletion is defined as deletion +of the selected text when an insertion is made. + + + + +XmNrenderTable + +Specifies the render table to be used in deriving a font set or font +for displaying text. If both a render table and a font list are +specified, the render table will take precedence. If the value of +XmNrenderTable is NULL at initialization, the parent hierarchy +of the widget is searched for an ancestor that holds the +XmQTspecifyRenderTable trait. If such an ancestor is found, the +font list is initialized to the XmTEXT_RENDER_TABLE value of the +ancestor widget. If no such ancestor is found, the default is +implementation dependent. + +TextField searches the render table for the first occurrence of a +rendition that has the tag _MOTIF_DEFAULT_LOCALE. If a default +element is not found, the first rendition in the table is used. Refer +to &cdeman.XmRenderTable; for more information on the render table +structure. + + + + +XmNresizeWidth + +Indicates that the TextField widget will attempt to resize its +width to accommodate all +the text contained in the widget when Boolean is True. + + + + +XmNselectionArray + +Defines the actions for multiple mouse clicks. Each mouse click +performed within some time of the previous mouse click will increment +the index into this array and perform the defined action for that +index. (This "multi-click" time is specified by the operating +environment, and varies among different systems. In general, it is +usually set to some fraction of a second.) +The possible actions are + + + +XmSELECT_POSITION + +Resets the insert cursor position + + + + +XmSELECT_WORD + +Selects a word + + + + +XmSELECT_LINE + +Selects a line of text + + + + + + + +XmNselectionArrayCount + +Specifies the number of actions that are defined in the +XmNselectionArray resource. +The value must not be negative. + + + + +XmNselectThreshold + +Specifies the number of pixels of motion that is required to select the +next character when selection is performed using the click-drag +mode of selection. +The value must not be negative. +This resource also specifies whether a drag should be started and the +number of pixels to start a drag when +Btn2Down and Btn1Down are integrated. + + + + +XmNvalue + +Specifies the string value of the TextField widget as a char* +data value. +Moves the cursor to position 0 unless a value of +XmNcursorPosition was explicitly supplied in the argument list. +If XmNvalue and XmNvalueWcs are both +defined, the value of XmNvalueWcs supersedes that of +XmNvalue. XtGetValues returns a copy of the value of +the internal buffer and XtSetValues copies the string values +into the internal buffer. + + + + +XmNvalueChangedCallback + +Specifies the list of callbacks that is called +after text is deleted from or inserted into +TextField. +The type of the structure whose address is passed to this callback is +XmAnyCallbackStruct. +The reason sent by the callback is XmCR_VALUE_CHANGED. +The XmNvalueChangedCallback should occur only in pairs +with a XmNmodifyVerifyCallback, assuming that the doit +flag in the callback structure of the XmNmodifyVerifyCallback is +not set to False. + + + + +XmNvalueWcs + +Specifies the string value of the TextField widget as a wchar_t* data +value. +Moves the cursor to position 0 unless a value of +XmNcursorPosition was explicitly supplied in the argument list. + +This resource cannot be specified in a resource file. + +If XmNvalue and XmNvalueWcs are both defined, +the value of XmNvalueWcs supersedes that of XmNvalue. +XtGetValues returns a copy of the value of the internal buffer +encoded as a wide character string. XtSetValues copies the +value of the wide character string into the internal buffer. + + + + +XmNverifyBell + +Specifies whether a bell will sound when an action is reversed +during a verification callback. +The default depends on the value of the ancestor VendorShell's +XmNaudibleWarning resource. + + + + + + +Inherited Resources +TextField widget inherits behavior and resources from the +superclasses in the following tables. +For a complete description of these resources, refer to the +reference page for that superclass. + + + + + + + + + + + +XmPrimitive Resource Set + + +Name +Class +Type +Default +Access + + +XmNbottomShadowColor +XmCBottomShadowColor +Pixel +dynamic +CSG + + +XmNbottomShadowPixmap +XmCBottomShadowPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNconvertCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNforeground +XmCForeground +Pixel +dynamic +CSG + + +XmNhelpCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNhighlightColor +XmCHighlightColor +Pixel +dynamic +CSG + + +XmNhighlightOnEnter +XmCHighlightOnEnter +Boolean +False +CSG + + +XmNhighlightPixmap +XmCHighlightPixmap +Pixmap +dynamic +CSG + + +XmNhighlightThickness +XmCHighlightThickness +Dimension +2 +CSG + + + +XmNlayoutDirection +XmCLayoutDirection +XmDirection +dynamic +CG + + +XmNnavigationType +XmCNavigationType +XmNavigationType +XmTAB_GROUP +CSG + + +XmNpopupHandlerCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNshadowThickness +XmCShadowThickness +Dimension +2 +CSG + + +XmNtopShadowColor +XmCTopShadowColor +Pixel +dynamic +CSG + + +XmNtopShadowPixmap +XmCTopShadowPixmap +Pixmap +dynamic +CSG + + +XmNtraversalOn +XmCTraversalOn +Boolean +True +CSG + + +XmNunitType +XmCUnitType +unsigned char +dynamic +CSG + + +XmNuserData +XmCUserData +XtPointer +NULL +CSG + + + + + + + + + + + + + + +Core Resource Set + + +Name +Class +Type +Default +Access + + +XmNaccelerators +XmCAccelerators +XtAccelerators +dynamic +CSG + + +XmNancestorSensitive +XmCSensitive +Boolean +dynamic +G + + +XmNbackground +XmCBackground +Pixel +dynamic +CSG + + +XmNbackgroundPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderColor +XmCBorderColor +Pixel +XtDefaultForeground +CSG + + +XmNborderPixmap +XmCPixmap +Pixmap +XmUNSPECIFIED_PIXMAP +CSG + + +XmNborderWidth +XmCBorderWidth +Dimension +0 +CSG + + +XmNcolormap +XmCColormap +Colormap +dynamic +CG + + +XmNdepth +XmCDepth +int +dynamic +CG + + +XmNdestroyCallback +XmCCallback +XtCallbackList +NULL +C + + +XmNheight +XmCHeight +Dimension +dynamic +CSG + + +XmNinitialResourcesPersistent +XmCInitialResourcesPersistent +Boolean +True +C + + +XmNmappedWhenManaged +XmCMappedWhenManaged +Boolean +True +CSG + + +XmNscreen +XmCScreen +Screen * +dynamic +CG + + +XmNsensitive +XmCSensitive +Boolean +True +CSG + + +XmNtranslations +XmCTranslations +XtTranslations +dynamic +CSG + + +XmNwidth +XmCWidth +Dimension +dynamic +CSG + + +XmNx +XmCPosition +Position +0 +CSG + + +XmNy +XmCPosition +Position +0 +CSG + + + + + + +Callback Information +A pointer to the following structure is passed to each callback: + +typedef struct +{ + int reason; + XEvent * event; +} XmAnyCallbackStruct; + + + + +reason + +Indicates why the callback was invoked + + + + +event + +Points to the XEvent that triggered the callback + + + + + +The TextField widget defines a new callback structure +for use with verification callbacks. Note that +not all of the fields are relevant for every +callback reason. The application must first +look at the reason field and use only the structure +members that are valid for the particular reason. +The values startPos, endPos, and text in the +callback structure XmTextVerifyCallbackStruct may be modified upon +receiving the callback, and these changes will be reflected as the +change made to the source of the TextField widget. (For example, all +keystrokes can be converted to spaces or NULL characters when a +password is entered into a TextField widget.) The application +programmer should not overwrite the text field, but should +attach data to that pointer. + +A pointer to the following structure is passed to the +callbacks for XmNlosingFocusCallback, XmNmodifyVerifyCallback, +and XmNmotionVerifyCallback. + +typedef struct +{ + int reason; + XEvent *event; + Boolean doit; + XmTextPosition currInsert, newInsert; + XmTextPosition startPos, endPos; + XmTextBlock text; +} XmTextVerifyCallbackStruct, *XmTextVerifyPtr; + + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent the triggered the callback. +It can be NULL. For example, changes made to the Text widget +programmatically do not have an event that can be +passed to the associated callback. + + + + +doit + +Indicates whether the action that invoked the callback will be performed. +Setting doit to False negates the action. +Note that not all actions may be negated. For example, +XmCR_LOSING_FOCUS callbacks may be beyond the control of the +widget if they are produced by mouse clicks. + + + + +currInsert + +Indicates the current position of the insert cursor. + + + + +newInsert + +Indicates the position at which the user attempts to position the insert +cursor. + + + + +startPos + +Indicates the starting position of the text to modify. If the callback is +not a modify verification callback, this value is the same as currInsert. + + + + +endPos + +Indicates the ending position of the text to modify. If no text is replaced or +deleted, then the value is the same as startPos. If the callback is not +a modify verification callback, this value is the same as currInsert. + + + + +text + +Points to the following structure of type +XmTextBlockRec. This structure holds +the textual information to be inserted. + +typedef struct +{ + char *ptr; + int length; + XmTextFormat format +} XmTextBlockRec, *XmTextBlock; + + + + +ptr + +The text to be inserted. ptr points to a temporary +storage space that is reused after the callback is finished. Therefore, +if an application needs to save the text to be inserted, it should copy +the text into its own data space. + + + + +length + +Specifies the length of the text to be inserted. + + + + +format + +Specifies the format of the text, +either XmFMT_8_BIT or XmFMT_16_BIT. + + + + + + + +A pointer to the following structure is passed to callbacks +for XmNmodifyVerifyCallbackWcs. + +typedef struct +{ + int reason; + XEvent *event; + Boolean doit; + XmTextPosition currInsert, newInsert; + XmTextPosition startPos, endPos; + XmWcsTextBlock text; +} XmTextVerifyCallbackStructWcs, *XmTextVerifyPtrWcs; + + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. For example, changes made to the Text widget +programmatically do not have an event that can be +passed to the associated callback. + + + + +doit + +Indicates whether the action that invoked the callback is performed. +Setting doit to False negates the action. +Note that not all actions may be negated. For example, +XmCR_LOSING_FOCUS callbacks may be beyond the control of the +widget if they are produced by mouse clicks. + + + + +currInsert + +Indicates the current position of the insert cursor. + + + + +newInsert + +Indicates the position at which the user attempts to position the insert +cursor. + + + + +startPos + +Indicates the starting position of the text to modify. If the callback is +not a modify verification callback, this value is the same +as currInsert. + + + + +endPos + +Indicates the ending position of the text to modify. If no text is +replaced or +deleted, the value is the same as startPos. If the callback is not +a modify verification callback, this value is the same as currInsert. + + + + +text + +Points to the following structure of type XmTextBlockRecWcs. +This structure holds +the textual information to be inserted. + +typedef struct +{ + wchar_t *wcsptr; + int length; +} XmTextBlockRecWcs, *XmTextBlockWcs; + + + +wcsptr + +Points to the wide character text to be inserted + + + + +length + +Specifies the number of characters to be inserted + + + + + + + +The following table describes the reasons for which the individual +verification callback structure fields are valid. Note that the +event field will never be valid for XmCR_MOVING_INSERT_CURSOR. + + + + + + + +Reason +Valid Fields + + +XmCR_LOSING_FOCUS +reason, event, doit + + +XmCR_MODIFYING_TEXT_VALUE +reason, event, doit, currInsert, newInsert, startPos, endPos, text + + +XmCR_MOVING_INSERT_CURSOR +reason, doit, currInsert, newInsert + + + + +A pointer to the following callback structure is passed to the +XmNdestinationCallback procedures: + +typedef struct +{ + int reason; + XEvent *event; + Atom selection; + XtEnum operation; + int flags; + XtPointer transfer_id; + XtPointer destination_data; + XtPointer location_data; + Time time; +} XmDestinationCallbackStruct; + + +reason + +Indicates why the callback was invoked. + + + + +event + +Points to the XEvent that triggered the callback. +It can be NULL. + + + + +selection + +Indicates the selection for which data transfer is being requested. +Possible values are CLIPBOARD, PRIMARY, SECONDARY, and +_MOTIF_DROP. + + + + +operation + +Indicates the type of transfer operation requested. + + + +When the selection is PRIMARY or SECONDARY, possible +values are XmMOVE, +XmCOPY, and XmLINK. + + + +When the selection is CLIPBOARD, possible +values are XmCOPY and XmLINK. + + + +When the selection is _MOTIF_DROP, possible values are +XmMOVE, XmCOPY, XmLINK, and XmOTHER. +A value of XmOTHER means that the callback procedure must get +further information from the XmDropProcCallbackStruct in the +destination_data member. + + + + + + +flags + +Indicates whether or not the destination widget is also the source of +the data to be transferred. +Following are the possible values: + + + +XmCONVERTING_NONE + +The destination widget is not the source of the data to be transferred. + + + + +XmCONVERTING_SAME + +The destination widget is the source of the data to be transferred. + + + + + + + +transfer_id + +Serves as a unique ID to identify the transfer transaction. + + + + +destination_data + +Contains information about the destination. +When the selection is _MOTIF_DROP, the callback procedures are +called by the drop site's XmNdropProc, and destination_data +is a pointer to the XmDropProcCallbackStruct passed to the +XmNdropProc procedure. +When the selection is SECONDARY, +destination_data +is an Atom +representing a target recommmended by the selection owner for use in +converting the selection. +Otherwise, destination_data is NULL. + + + + +location_data + +Contains information about the location where data is to be transferred. +The value is always NULL when the selection is CLIPBOARD. +If the value is NULL, the data is to be inserted at the widget's cursor +position. +Otherwise, the value is a pointer to an XPoint structure +containing the x and y coordinates at the location where the data is to +be transferred. Once XmTransferDone procedures start to be called, +location_data will no longer be stable. + + + + +time + +Indicates the time when the transfer operation began. + + + + + + + + + + + + + + + + +Translations +The XmTextField translations are described in the following list. +The actions represent the effective behavior of the associated events, +and they may differ in a right-to-left language environment. + +The following key names are listed in the +X standard key event translation table syntax. +This format is the one used by Motif to +specify the widget actions corresponding to a given key. +A brief overview of the format is provided under +&cdeman.VirtualBindings;. +For a complete description of the format, please refer to the +X Toolkit Instrinsics Documentation. + + + +≈c s ≈m ≈a Btn1Down: + +extend-start() + + + + +c ≈s ≈m ≈a Btn1Down: + +move-destination() + + + + +≈c ≈s ≈m ≈a Btn1Down: + +grab-focus() + + + + +≈c ≈m ≈a Btn1Motion: + +extend-adjust() + + + + +≈c ≈m ≈a Btn1Up: + +extend-end() + + + + +Btn2Down: + +process-bdrag() + + + + +m ≈a Btn2Motion: + +secondary-adjust() + + + + +≈m a Btn2Motion: + +secondary-adjust() + + + + +s c <Btn2Up>: + +link-to() + + + + +≈s Btn2Up: + +copy-to() + + + + +≈c Btn2Up: + +move-to() + + + + +:m KeyosfPrimaryPaste: + +cut-primary() + + + + +:a KeyosfPrimaryPaste: + +cut-primary() + + + + +:KeyosfPrimaryPaste: + +copy-primary() + + + + +:m KeyosfCut: + +cut-primary() + + + + +:a KeyosfCut: + +cut-primary() + + + + +:KeyosfCut: + +cut-clipboard() + + + + +:KeyosfPaste: + +paste-clipboard() + + + + +:m KeyosfCopy: + +copy-primary() + + + + +:a KeyosfCopy: + +copy-primary() + + + + +:KeyosfCopy: + +copy-clipboard() + + + + +:s KeyosfBeginLine: + +beginning-of-line(extend) + + + + +:KeyosfBeginLine: + +beginning-of-line() + + + + +:s KeyosfEndLine: + +end-of-line(extend) + + + + +:KeyosfEndLine: + +end-of-line() + + + + +:s KeyosfPageLeft: + +page-left(extend) + + + + +:KeyosfPageLeft: + +page-left() + + + + +:s cKeyosfPageUp: + +page-left(extend) + + + + +:c KeyosfPageUp: + +page-left() + + + + +:s KeyosfPageRight: + +page-right(extend) + + + + +:KeyosfPageRight: + +page-right() + + + + +s c KeyosfPageDown: + +page-right(extend) + + + + +:c KeyosfPageDown: + +page-right() + + + + +:KeyosfClear: + +clear-selection() + + + + +:KeyosfBackSpace: + +delete-previous-character() + + + + +:s m KeyosfDelete: + +cut-primary() + + + + +:s a KeyosfDelete: + +cut-primary() + + + + +:s KeyosfDelete: + +cut-clipboard() + + + + +:c KeyosfDelete: + +delete-to-end-of-line() + + + + +:KeyosfDelete: + +delete-next-character() + + + + +:c m KeyosfInsert: + +copy-primary() + + + + +:c a KeyosfInsert: + +copy-primary() + + + + +:s KeyosfInsert: + +paste-clipboard() + + + + +:c KeyosfInsert: + +copy-clipboard() + + + + +:KeyosfInsert: + +toggle-overstrike() + + + + +:s KeyosfSelect: + +key-select() + + + + +:KeyosfSelect: + +set-anchor() + + + + +:KeyosfSelectAll: + +select-all() + + + + +:KeyosfDeselectAll: + +deselect-all() + + + + +:KeyosfActivate: + +activate() + + + + +:KeyosfAddMode: + +toggle-add-mode() + + + + +:KeyosfHelp: + +Help() + + + + +:KeyosfCancel: + +process-cancel() + + + + +:s c KeyosfLeft: + +backward-word(extend) + + + + +:c KeyosfLeft: + +backward-word() + + + + +:s KeyosfLeft: + +key-select(left) + + + + +:KeyosfLeft: + +backward-character() + + + + +:s c KeyosfRight: + +forward-word(extend) + + + + +:c KeyosfRight: + +forward-word() + + + + +:s KeyosfRight: + +key-select(right) + + + + +:KeyosfRight: + +forward-character() + + + + +:KeyosfUp: + +traverse-prev() + + + + +:KeyosfDown: + +traverse-next() + + + + +c ≈m ≈a Keyslash: + +select-all() + + + + +c ≈m ≈a Keybackslash: + +deselect-all() + + + + +s ≈m ≈a KeyTab: + +prev-tab-group() + + + + +≈m ≈a KeyTab: + +next-tab-group() + + + + +≈s ≈m ≈a KeyReturn: + +activate() + + + + +c ≈s ≈m ≈a Keyspace: + +set-anchor() + + + + +c s ≈m ≈a Keyspace: + +key-select() + + + + +s ≈c ≈m ≈a Keyspace: + +self-insert() + + + + +Key: + +self-insert() + + + + + +The TextField button event translations are modified when Display's +XmNenableBtn1Transfer resource does not have a value of +XmOFF (in other words, it is either XmBUTTON2_TRANSFER or +XmBUTTON2_ADJUST). This +option allows the +actions for selection and transfer to be integrated on Btn1. +The actions for Btn1 that are defined above +still apply when the Btn1 event occurs over text that is not +selected. The following actions apply when the Btn1 event +occurs over text that is selected: + + + +Btn1Down: + +process-bdrag(). + + + + +ShiftBtn1Down: + +process-bdrag(). + + + + +Btn1DownShiftBtn1Up: + +grab-focus(), extend-end. + + + + +ShiftBtn1DownShiftBtn1Up: + +extend-start(), extend-end(). + + + + +CtrlBtn1DownShiftBtn1Up: + +move-destination(). + + + + +CtrlBtn1Down: + +process-bdrag(). + + + + +When Display's XmNenableBtn1Transfer resource has a value of +XmBUTTON2_ADJUST, the following actions apply: + + + +Btn2Down: + +extend-start(). + + + + +Btn2Motion: + +extend-adjust(). + + + + +Btn2Up: + +extend-end(). + + + + + + +Action Routines +The XmTextField action routines are + + + +activate(): + +Calls the callbacks for XmNactivateCallback. +If the parent is a manager, passes the event to the parent. + + + + +backward-character(extend): + +Moves the insertion cursor one character to the left. +This action may have different behavior in a right-to-left language +environment. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The backward-character() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +backward-character() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +backward-word(extend): + +If this action is called with no argument, +moves the insertion cursor to the first non-whitespace character after the +first whitespace character to the left or after the beginning of the line. +If the insertion cursor is already at the beginning of a word, +moves the insertion cursor to the beginning of the previous word. +This action may have different behavior in a locale other than the C locale. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The backward-word() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +backward-word() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +beginning-of-line(extend): + +If this action is called with no argument, +moves the insertion cursor to the beginning of the line. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The beginning-of-line() action produces calls to the +XmNmotionVerifyCallback with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +beginning-of-line() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +clear-selection(): + +Clears the current selection by replacing each character except +Return with a space character. + +The clear-selection() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +copy-clipboard(): + +If this widget owns the primary selection, this action copies the +selection to the clipboard. +This action calls the XmNconvertCallback procedures, possibly +multiple times, for the CLIPBOARD selection. + + + + +copy-primary(): + +Copies the primary selection to just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmCOPY operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. + +In addition, the copy-primary() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The copy-primary() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +copy-to(): + +If a secondary selection exists, this action copies the secondary +selection to the insertion position of the destination component. +If the primary selection is in the destination widget, it will +be deselected. Otherwise, there is no effect on the primary selection. + +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmCOPY operation. +The destination's XmNdestinationCallback procedures or the +destination component itself invokes the selection owner's +XmNconvertCallback procedures, possibly multiple times, for the +SECONDARY selection. + +If no secondary selection exists, this action copies the primary +selection to the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmCOPY operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. + +In addition, the copy-to() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If there is no secondary selection, the +copy-to() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +cut-clipboard(): + +If this widget owns the primary selection, this action cuts the +selection to the clipboard. +This action calls the XmNconvertCallback procedures, possibly +multiple times, for the CLIPBOARD selection. +If the transfer is successful, this action then calls the +XmNconvertCallback procedures for the CLIPBOARD selection +and the DELETE target. + +In addition, the cut-clipboard() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +cut-primary(): + +Cuts the primary selection and pastes it just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmMOVE operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the PRIMARY +selection and the DELETE target. + +In addition, the cut-primary() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR, the XmNmodifyVerifyCallback +procedures with reason value XmCR_MODIFYING_TEXT_VALUE, and the +XmNvalueChangedCallback procedures with reason value +XmCR_VALUE_CHANGED. + + + + +delete-next-character(): + +In normal mode, if there is a nonnull selection, deletes the selection; +otherwise, +deletes the character following the insertion cursor. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; +otherwise, +deletes the character following the insertion cursor. +This may impact the selection. + +The delete-next-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-next-word(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next space, tab +or end-of-line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next space, tab +or end-of-line character. +This may impact the selection. +This action may have different behavior in a locale other than the C locale. + +The delete-next-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-previous-character(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the character of text immediately preceding the insertion cursor. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the character of text immediately preceding the insertion cursor. +This may impact the selection. + +The delete-previous-character() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +delete-previous-word(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters preceding the insertion cursor +to the next +space, tab or beginning-of-line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters preceding the insertion cursor to the next space, +tab or beginning-of-line character. +This may impact the selection. +This action may have different behavior in a locale other than the C locale. + +The delete-previous-word() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +delete-selection(): + +Deletes the current selection. + +The delete-selection() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +delete-to-end-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next end of +line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters following the insertion cursor to the next end +of line character. +This may impact the selection. + +The delete-to-end-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, and the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED. + + + + +delete-to-start-of-line(): + +In normal mode, if there is a nonnull selection, deletes the selection; otherwise, +deletes the characters preceding the insertion cursor to the previous +beginning-of-line character. +In add mode, if there is a nonnull selection, the cursor is not disjoint +from the selection and XmNpendingDelete is set to True, +deletes the selection; otherwise, +deletes the characters preceding the insertion cursor +to the previous beginning-of-line character. +This may impact the selection. + +The delete-to-start-of-line() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +deselect-all(): + +Deselects the current selection. + +The deselect-all() action produces no callbacks. + + + + +end-of-line(extend): + +If this action is called with no argument, +moves the insertion cursor to the end of the line. +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The end-of-line() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +end-of-line() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-adjust(): + +Selects text from the anchor to the pointer position and deselects text +outside that range. + +The extend-adjust() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The extend-adjust() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-end(): + +Moves the insertion cursor to the position of the pointer. +The extend-end() action is used to commit the selection. After +this action has been done, process-cancel() will no longer +cancel the selection. + +The extend-end() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The extend-end() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +extend-start(): + +Adjusts the anchor using the balance-beam method. +Selects text from the anchor to the pointer position and deselects text +outside that range. + +The extend-start() action can produce no callbacks, +however, it may produce calls to the +XmNgainPrimaryCallback and XmNmotionVerifyCallback procedures. +See callback description for more information. + + + + +forward-character(extend): + +Moves the insertion cursor one character to the right. +This action may have different behavior in a right-to-left language +environment. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The forward-character() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +forward-character() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +forward-word(extend): + +If this action is called with no argument, moves the insertion cursor to +the first whitespace character or end-of-line following the next +non-whitespace character. +If the insertion cursor is already at the end of a word, +moves the insertion cursor to the end of the next word. +This action may have different behavior in a locale other than the C locale. + +If called with an argument of extend, moves the insertion cursor as +in the case of no argument and extends the current selection. + +The forward-word() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +If called with the extend argument, the +forward-word() action may produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +grab-focus(): + +This key binding performs the action defined in the +XmNselectionArray, depending on the number of multiple mouse +clicks. +The default selection array ordering is one click to move the +insertion cursor to the pointer position, two clicks to select a word, +and three +clicks to select a line of text. +A single click also deselects any selected text and sets the anchor at +the pointer position. +This action may have different behavior in a locale other than the C locale. + +The grab-focus() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +Help(): + +Calls the callbacks for XmNhelpCallback if any exist. +If there are no help +callbacks for this widget, this action calls the help callbacks +for the nearest ancestor that has them. + + + + +key-select(right|left): + +If called with an argument of right, moves the insertion cursor +one character to the right and extends the current selection. +If called with an argument of left, moves the insertion cursor +one character to the left and extends the current selection. +If called with no argument, extends the current selection. + +Note that after a key-select action, the selection will still +begin at the original anchor, and will extend to the position +indicated in the action call. If this new position is on the opposite +side of the selection anchor from the previous selection boundary, the +original selection will be deselected. + +The key-select() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. +The key-select() action may also produce calls to the +XmNgainPrimaryCallback procedures. +See callback description for more information. + + + + +link-primary(): + +Places a link to the primary selection just before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmLINK operation. +The TextField widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the primary selection and for taking any related actions. + + + + +link-to(): + +If a secondary selection exists, this action places a link to the +secondary selection at the insertion position of the destination +component. +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmLINK operation. + +If no secondary selection exists, this action places a link to the +primary selection at the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmLINK operation. + +The TextField widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the primary or secondary selection and for taking any +related actions. + + + + +move-destination(): + +Moves the insertion cursor to the pointer position without changing any +existing current selection. +If there is +a +current selection, sets the widget as the destination widget. +This also moves the widget focus to match the insertion cursor. + +The move-destination() action produces calls to the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +move-to(): + +If a secondary selection exists, this action moves the secondary +selection to the insertion position of the destination component. +If the secondary selection is in the destination widget, and the +secondary selection and the primary selection overlap, the result +is undefined. +This action calls the destination's XmNdestinationCallback +procedures for the SECONDARY selection and the +XmCOPY operation. +The destination's XmNdestinationCallback procedures or the +destination component itself invokes the selection owner's +XmNconvertCallback procedures, possibly multiple times, for the +SECONDARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the SECONDARY +selection and the DELETE target. + +If no secondary selection exists, this action moves the primary +selection to the pointer position. +This action calls the XmNdestinationCallback procedures for the +PRIMARY selection and the XmMOVE operation. +It calls the selection owner's XmNconvertCallback procedures, +possibly multiple times, for the PRIMARY selection. +If the transfer is successful, this action then calls the selection +owner's XmNconvertCallback procedures for the PRIMARY +selection and the DELETE target. + +In addition, the move-to() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. This action may also produce calls +to the XmNgainPrimaryCallback procedures. + + + + +next-tab-group(): + +Traverses to the next tab group. + +The next-tab-group() action produces no callbacks, unless it +results in the widget losing focus, in which case, the +XmNlosingFocusCallback procedures are called with reason value +XmCR_LOSING_FOCUS. + + + + +page-left(): + +Scrolls the viewing window left one page of text. + +The page-left() action produces no callbacks. + + + + +page-right(): + +Scrolls the viewing window right one page of text. + +The page-right() action produces no callbacks. + + + + +paste-clipboard(): + +Pastes the contents of the clipboard before the insertion cursor. +This action calls the XmNdestinationCallback procedures for the +CLIPBOARD selection and the XmCOPY operation. + +The paste-clipboard() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +prev-tab-group(): + +Traverses to the previous tab group. + +The prev-tab-group() action produces no callbacks, unless it +results in the widget losing focus, in which case, the +XmNlosingFocusCallback procedures are called with reason value +XmCR_LOSING_FOCUS. + + + + +process-bdrag() + +If the pointer is within the selection, this action starts a drag +operation for the selection. +This action sets the XmNconvertProc of the DragContext to a +function that calls the XmNconvertCallback procedures, possibly +multiple times, for the _MOTIF_DROP selection. + +If no selection exists or the pointer is outside the selection, this +action prepares to start a secondary selection at the pointer position. + + + + +process-cancel(): + +Cancels the current extend-adjust(), secondary-adjust() +or process-bdrag() +operation and leaves the selection state as it was before the operation; +otherwise, and +if +the parent is a manager, it passes the event to the parent. + + + + +secondary-adjust(): + +Extends the secondary selection to the pointer position. + +The secondary-adjust() action produces no callbacks. + + + + +secondary-start(): + +Marks the beginning of a secondary selection. + +The secondary-start() action produces no callbacks. + + + + +select-all(): + +Selects all text. + +The select-all() action can produce no callbacks, +however, it may produce calls to the +XmNgainPrimaryCallback and XmNmotionVerifyCallback procedures. +See callback description for more information. + + + + +self-insert(): + +If XmNpendingDelete is True and the cursor is not disjoint from the +current selection, deletes the entire selection. +Inserts the character associated with the key pressed +before the insertion cursor. + +The self-insert() action produces calls to the +XmNmodifyVerifyCallback procedures with reason value +XmCR_MODIFYING_TEXT_VALUE, the XmNvalueChangedCallback +procedures with reason value XmCR_VALUE_CHANGED, and the +XmNmotionVerifyCallback procedures with reason value +XmCR_MOVING_INSERT_CURSOR. + + + + +set-anchor(): + +Resets the anchor point for extended selections. +Resets the destination of secondary selection actions. + +The set-anchor() action produces no callbacks. + + + + +toggle-add-mode(): + +Toggles the state of Add Mode. + +The toggle-add-mode() action produces no callbacks. + + + + +toggle-overstrike(): + +Toggles the state of the text insertion mode. By default, +characters typed into the TextField widget are inserted before +the position of the insertion cursor. In overstrike +mode, characters entered into the TextField widget replace +the characters that directly follow the insertion cursor. +In overstrike mode, when the end of a line is reached, +characters are appended to the end of the line. + +The following traversal actions generate no callbacks unless they +result in the loss of focus by the widget in question, as when +XmNnavigationType is XmNONE. In this case, +they produce calls to the XmNlosingFocusCallback procedures, +with reason value XmCR_FOCUS_MOVED. + + + + +traverse-home(): + +Traverses to the first widget in the tab group. + + + + +traverse-next(): + +Traverses to the next widget in the tab group. + + + + +traverse-prev(): + +Traverses to the previous widget in the tab group. + + + + + + +Additional Behavior +This widget has the following additional behavior: + + + +FocusIn: + +Draws the insertion cursor as solid and starts blinking the cursor. + + + + +FocusOut: + +Displays the insertion cursor as a stippled I-beam unless it is the destination +widget. + + + + + + +Virtual Bindings +The bindings for virtual keys are vendor specific. +For information about bindings for virtual buttons and keys, +see &cdeman.VirtualBindings;. + + + + +RELATED +&cdeman.Core;, +&cdeman.XmCreateTextField;, +&cdeman.XmFontList;, +&cdeman.XmFontListAppendEntry;, +&cdeman.XmPrimitive;, +&cdeman.XmTextFieldClearSelection;, +&cdeman.XmTextFieldCopy;, +&cdeman.XmTextFieldCopyLink;, +&cdeman.XmTextFieldCut;, +&cdeman.XmTextFieldGetBaseline;, +&cdeman.XmTextFieldGetEditable;, +&cdeman.XmTextFieldGetInsertionPosition;, +&cdeman.XmTextFieldGetLastPosition;, +&cdeman.XmTextFieldGetMaxLength;, +&cdeman.XmTextFieldGetSelection;, +&cdeman.XmTextFieldGetSelectionPosition;, +&cdeman.XmTextFieldGetSelectionWcs;, +&cdeman.XmTextFieldGetString;, +&cdeman.XmTextFieldGetStringWcs;, +&cdeman.XmTextFieldGetSubstring;, +&cdeman.XmTextFieldGetSubstringWcs;, +&cdeman.XmTextFieldInsert;, +&cdeman.XmTextFieldInsertWcs;, +&cdeman.XmTextFieldPaste;, +&cdeman.XmTextFieldPasteLink;, +&cdeman.XmTextFieldPosToXY;, +&cdeman.XmTextFieldRemove;, +&cdeman.XmTextFieldReplace;, +&cdeman.XmTextFieldReplaceWcs;, +&cdeman.XmTextFieldSetAddMode;, +&cdeman.XmTextFieldSetEditable;, +&cdeman.XmTextFieldSetHighlight;, +&cdeman.XmTextFieldSetInsertionPosition;, +&cdeman.XmTextFieldSetMaxLength;, +&cdeman.XmTextFieldSetSelection;, +&cdeman.XmTextFieldSetString;, +&cdeman.XmTextFieldSetStringWcs;, +&cdeman.XmTextFieldShowPosition;, and +&cdeman.XmTextFieldXYToPos;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAB.sgm new file mode 100644 index 00000000..4aff53a6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAB.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmTextFieldClearSelection +library call + + +XmTextFieldClearSelection +A TextField function that clears the primary selection + +XmTextFieldClearSelection + +TextField functions +XmTextFieldClearSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldClearSelection + +Widget widget +Time time + + + +DESCRIPTION +XmTextFieldClearSelection clears the primary selection +in the TextField widget. + + + +widget + +Specifies the TextField widget ID. + + + + +time + +Specifies the time at which the selection value is desired. This +should be the time of the event that triggered this request. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAC.sgm new file mode 100644 index 00000000..7ce83bd4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAC.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmTextFieldCopy +library call + + +XmTextFieldCopy +A TextField function that copies the primary selection to the clipboard + +XmTextFieldCopy + +TextField functions +XmTextFieldCopy + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldCopy + +Widget widget +Time time + + + +DESCRIPTION +XmTextFieldCopy copies the primary selected text to the clipboard. + +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmCOPY. + + + +widget + +Specifies the TextField widget ID. + + + + +time + +Specifies the time at which the selection value is to be modified. This +should be the time of the event that triggered this request. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN + +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAD.sgm new file mode 100644 index 00000000..6ccb9711 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAD.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmTextFieldCopyLink +library call + + +XmTextFieldCopyLink +A TextField function that copies a link to the primary selection to the clipboard + +XmTextFieldCopyLink + +TextField functions +XmTextFieldCopyLink + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldCopyLink + +Widget widget +Time time + + + +DESCRIPTION +XmTextFieldCopyLink copies a link to the primary selected text to +the clipboard. +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmLINK. +The TextField widget itself does not copy any links; +XmNconvertCallback procedures are responsible for copying the link +to the clipboard and for taking any related actions. + + + +widget + +Specifies the TextField widget ID. + + + + +time + +Specifies the time of the transfer. +This should be the time of the event which triggered this request. +One source of a valid time stamp is the function +XtLastTimestampProcessed. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAE.sgm new file mode 100644 index 00000000..e97d1c71 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAE.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmTextFieldCut +library call + + +XmTextFieldCut +A TextField function that copies the primary selection to the clipboard and deletes the selected text + +XmTextFieldCut + +TextField functions +XmTextFieldCut + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldCut + +Widget widget +Time time + + + +DESCRIPTION +XmTextFieldCut copies the primary selected text to the clipboard and +then deletes the primary selected text. +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. + +This routine calls the XmNconvertCallback procedures, possibly +multiple times, with the selection member of the +XmConvertCallbackStruct set to CLIPBOARD and with the +parm member set to XmMOVE. +If the transfer is successful, this routine then calls the +XmNconvertCallback procedures for the CLIPBOARD selection +and the DELETE target. + + + +widget + +Specifies the TextField widget ID. + + + + +time + +Specifies the time at which the selection value is to be modified. This +should be the time of the event that triggered this request. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN + +This function returns False if the primary selection is NULL, if the +widget does not own the primary selection, if the function is +unable to gain ownership of the clipboard selection, or if no data is +placed on the clipboard. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAF.sgm new file mode 100644 index 00000000..49de3e3a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAF.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmTextFieldGetBaseline +library call + + +XmTextFieldGetBaseline +A TextField function that accesses the y position of the baseline + +XmTextFieldGetBaseline + +TextField functions +XmTextFieldGetBaseline + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +int XmTextFieldGetBaseline + +Widget widget + + + +DESCRIPTION +XmTextFieldGetBaseline accesses the y position of the +baseline in the TextField widget, +relative to the y position of the top of the widget. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns an integer value that indicates the y position +of the baseline in the TextField widget. +The calculation takes into account the +margin height, shadow thickness, highlight thickness, and font ascent of +the first font (set) in the fontlist used for drawing text. +In this calculation, the +y position of the top of the widget is 0 (zero). + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAG.sgm new file mode 100644 index 00000000..8c8c435a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAG.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmTextFieldGetEditable +library call + + +XmTextFieldGetEditable +A TextField function that accesses the edit permission state + +XmTextFieldGetEditable + +TextField functions +XmTextFieldGetEditable + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldGetEditable + +Widget widget + + + +DESCRIPTION +XmTextFieldGetEditable accesses the edit permission state of the TextField widget. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns a Boolean value that indicates the state of the XmNeditable +resource. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAH.sgm new file mode 100644 index 00000000..d9b3c32b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAH.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmTextFieldGetInsertionPosition +library call + + +XmTextFieldGetInsertionPosition +A TextField function that accesses the position of the insertion cursor + +XmTextFieldGetInsertion\\%Position + +TextField functions +XmTextFieldGetInsertion\\%Position + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +XmTextPosition XmTextFieldGetInsertionPosition + +Widget widget + + + +DESCRIPTION +XmTextFieldGetInsertionPosition accesses the insertion cursor +position of the TextField widget. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns an XmTextPosition value that indicates the state of the +XmNcursorPosition resource. This is an integer number of +characters from the beginning of the text buffer. The first character +position is 0 (zero). + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAI.sgm new file mode 100644 index 00000000..6f4a6428 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAI.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextFieldGetLastPosition +library call + + +XmTextFieldGetLastPosition +A TextField function that accesses the position of the last text character + +XmTextFieldGetLastPosition + +TextField functions +XmTextFieldGetLastPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +XmTextPosition XmTextFieldGetLastPosition + +Widget widget + + + +DESCRIPTION +XmTextFieldGetLastPosition accesses the position of the +last character in the text buffer of the TextField widget. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns an XmTextPosition value that indicates the position of the last +character in the text buffer. This is an integer number of +characters from the beginning of the buffer. The first character +position is 0 (zero). +The last character position is equal to the number of characters +in the text buffer. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAJ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAJ.sgm new file mode 100644 index 00000000..9108c984 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAJ.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextFieldGetMaxLength +library call + + +XmTextFieldGetMaxLength +A TextField function that accesses the value of the current maximum allowable length of a text string entered from the keyboard + +XmTextFieldGetMaxLength + +TextField functions +XmTextFieldGetMaxLength + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +int XmTextFieldGetMaxLength + +Widget widget + + + +DESCRIPTION +XmTextFieldGetMaxLength accesses the value of the current maximum allowable +length of the text string in the TextField widget entered from the +keyboard. The maximum allowable length +prevents the user from entering a text string larger than this limit. +Note that the maximum allowable length is the same as the value +of the widget's XmNmaxLength resource. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns the integer value that indicates the string's maximum allowable +length that can be entered from the keyboard. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAK.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAK.sgm new file mode 100644 index 00000000..28c5775c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAK.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmTextFieldGetSelection +library call + + +XmTextFieldGetSelection +A TextField function that retrieves the value of the primary selection + +XmTextFieldGetSelection + +TextField functions +XmTextFieldGetSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +char * XmTextFieldGetSelection + +Widget widget + + + +DESCRIPTION +XmTextFieldGetSelection +retrieves the value of the primary selection. It returns +a NULL pointer if no text is selected in the widget. The application is +responsible for freeing the storage associated with the string by calling +XtFree. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns a character pointer to the string that is associated with the +primary selection. + + + +RELATED +&cdeman.XmTextField; and &cdeman.XmTextFieldGetSelectionWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAL.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAL.sgm new file mode 100644 index 00000000..3a48a680 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAL.sgm @@ -0,0 +1,104 @@ + + + + + + + + + + + +XmTextFieldGetSelectionPosition +library call + + +XmTextFieldGetSelectionPosition +A TextField function that accesses the position of the primary selection + +XmTextFieldGetSelection\\%Position + +TextField functions +XmTextFieldGetSelection\\%Position + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldGetSelectionPosition + +Widget widget +XmTextPosition *left +XmTextPosition *right + + + +DESCRIPTION +XmTextFieldGetSelectionPosition accesses the left and right position of +the primary selection in the text buffer of the TextField widget. + + + +widget + +Specifies the TextField widget ID + + + + +left + +Specifies the pointer in which the position of the left boundary of the +primary selection is returned. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + + +right + +Specifies the pointer in which the position of the right boundary of the +primary selection is returned. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +This function returns True if the widget owns the primary selection; +otherwise, it returns False. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAM.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAM.sgm new file mode 100644 index 00000000..0aab86df --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAM.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmTextFieldGetSelectionWcs +library call + + +XmTextFieldGetSelectionWcs +A TextField function that retrieves the +value of a wide character encoded primary selection + +XmTextFieldGetSelection\\%Wcs + +TextField functions +XmTextFieldGetSelection\\%Wcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +wchar_t * XmTextFieldGetSelectionWcs + +Widget widget + + + +DESCRIPTION +XmTextFieldGetSelectionWcs retrieves the value of the primary +selection, encoded in a wide character format. It returns a +NULL pointer if no text is selected in the widget. The application +is responsible for freeing the storage associated with the wide +character buffer by calling XtFree. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns the wide character string that is associated with the primary +selection in the TextField widget. + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldGetSelection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAN.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAN.sgm new file mode 100644 index 00000000..7d5f6dff --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAN.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextFieldGetString +library call + + +XmTextFieldGetString +A TextField function that accesses the string value + +XmTextFieldGetString + +TextField functions +XmTextFieldGetString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +char * XmTextFieldGetString + +Widget widget + + + +DESCRIPTION +XmTextFieldGetString +accesses the string value of the TextField widget. The application +is responsible for freeing the storage associated with the string by +calling XtFree. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns a character pointer to the string value of the TextField widget. +This returned value is a copy of the value of the XmNvalue resource. +Returns an empty string if the length of the TextField widget's +string is 0 (zero). + + + +RELATED +&cdeman.XmTextField; and &cdeman.XmTextFieldGetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAO.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAO.sgm new file mode 100644 index 00000000..a73498b2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAO.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextFieldGetStringWcs +library call + + +XmTextFieldGetStringWcs +A TextField function that retrieves a copy +of the wide character string value of a TextField widget + +XmTextFieldGetStringWcs + +TextField functions +XmTextFieldGetStringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +wchar_t * XmTextFieldGetStringWcs + +Widget widget + + + +DESCRIPTION +XmTextFieldGetStringWcs retrieves a copy of the wide character +string value of the TextField widget. The application is responsible +for freeing the storage associated with the string by calling XtFree. + + + +widget + +Specifies the TextField widget ID + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns the wide character string value of the TextField widget. The +function returns an empty string if the length of the TextField +widget's string is 0 (zero). + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldGetString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAP.sgm new file mode 100644 index 00000000..c8acff4a --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAP.sgm @@ -0,0 +1,165 @@ + + + + + + + + + + + +XmTextFieldGetSubstring +library call + + +XmTextFieldGetSubstring +A TextField function that retrieves a copy +of a portion of the internal text buffer + +XmTextFieldGetSubstring + +TextField functions +XmTextFieldGetSubstring + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +int XmTextFieldGetSubstring + +Widget widget +XmTextPosition start +int num_chars +int buffer_size +char *buffer + + + +DESCRIPTION +XmTextFieldGetSubstring retrieves a copy of a portion +of the internal text buffer of a TextField widget. The function +copies a specified number of characters from a given start position +in the internal text buffer into a buffer provided by the application. +A NULL terminator is placed at the end of the copied data. + +The size of the required buffer depends on the maximum number +of bytes per character (MB_CUR_MAX) for the current locale. +MB_CUR_MAX is a macro defined in stdlib.h. The buffer +should be large enough to contain the substring to be copied +and a NULL terminator. Use the following equation to calculate +the size of buffer the application should provide: + + +buffer_size = (num_chars* MB_CUR_MAX) + 1 + + + + + +widget + +Specifies the TextField widget ID. + + + + +start + +Specifies the beginning character position from which the data +will be retrieved. This is an integer number of characters from +the beginning of the text buffer. The first character position +is 0 (zero). + + + + +num_chars + +Specifies the number of characters to be copied into the provided +buffer. + + + + +buffer_size + +Specifies the size of the supplied buffer in bytes. This size +should account for a NULL terminator. + + + + +buffer + +Specifies the character buffer into which the internal +text buffer will be copied. + + + + +For a complete definition of TextField and its associated resources, +see &cdeman.XmTextField;. + + + +RETURN + + +XmCOPY_SUCCEEDED + +The function was successful. + + + + +XmCOPY_FAILED + +The function failed because it was unable to copy the +specified number of characters into the buffer provided. +The buffer size may be insufficient. The contents of +buffer are undefined. + + + + +XmCOPY_TRUNCATED + +The requested number of characters extended beyond the internal +buffer. The function copied characters between start and +the end of the widget's buffer and terminated the string with +a NULL terminator; fewer than num_chars characters were +copied. + + + + + + +RELATED +&cdeman.XmTextField; and &cdeman.XmTextFieldGetSubstringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAQ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAQ.sgm new file mode 100644 index 00000000..5b4dbc06 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAQ.sgm @@ -0,0 +1,152 @@ + + + + + + + + + + + +XmTextFieldGetSubstringWcs +library call + + +XmTextFieldGetSubstringWcs +A TextField function that retrieves a +portion of a wide character internal text buffer + +XmTextFieldGetSubstring\\%Wcs + +TextField functions +XmTextFieldGetSubstring\\%Wcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +int XmTextFieldGetSubstringWcs + +Widget widget +XmTextPosition start +int num_chars +int buffer_size +wchar_t *buffer + + + +DESCRIPTION +XmTextFieldGetSubstringWcs retrieves a copy of a portion of the internal +text buffer of a TextField widget that is stored in a wide character +format. The function copies a specified number of characters from +a given start position in the internal text buffer into a buffer +provided by the application. A NULL terminator is placed at the +end of the copied data. + + + +widget + +Specifies the TextField widget ID. + + + + +start + +Specifies the beginning character position from which the data will be +retrieved. This is an integer number of characters from the beginning of +the text buffer. The first character position is 0 (zero). + + + + +num_chars + +Specifies the number of wchar_t characters to be copied into +the provided buffer. + + + + +buffer_size + +Specifies the size of the supplied buffer as a number of wchar_t +storage locations. The minimum size is num_chars + 1. + + + + +buffer + +Specifies the wide character buffer into which the internal +text buffer will be copied. + + + + +For a complete definition of TextField and its associated resources, +see &cdeman.XmTextField;. + + + +RETURN + + +XmCOPY_SUCCEEDED + +The function was successful. + + + + +XmCOPY_FAILED + +The function failed because it was unable to copy the +specified number of characters into the buffer provided. +The buffer size may be insufficient. The contents of +buffer are undefined. + + + + +XmCOPY_TRUNCATED + +The requested number of characters extended beyond the internal +buffer. The function copied characters to the end of the buffer +and terminated the string with a NULL terminator; fewer than +num_chars characters were copied. + + + + + + +RELATED +&cdeman.XmTextField; and &cdeman.XmTextFieldGetSubstring;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAR.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAR.sgm new file mode 100644 index 00000000..7dcefe59 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAR.sgm @@ -0,0 +1,108 @@ + + + + + + + + + + + +XmTextFieldInsert +library call + + +XmTextFieldInsert +A TextField function that inserts a character string into a text string + +XmTextFieldInsert + +TextField functions +XmTextFieldInsert + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldInsert + +Widget widget +XmTextPosition position +char * value + + + +DESCRIPTION +XmTextFieldInsert inserts a character string into the text string in +the TextField widget. The character positions begin at 0 (zero) +and are numbered +sequentially from the beginning of the text. For example, to insert a +string after the fourth character, +the position parameter must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +position, the XmNmotionVerifyCallback is called. + + + +widget + +Specifies the TextField widget ID + + + + +position + +Specifies the position in the text string where the character string is +to be inserted + + + + +value + +Specifies the character string value to be added to the text widget + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; and &cdeman.XmTextFieldInsertWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAS.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAS.sgm new file mode 100644 index 00000000..da631f1f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAS.sgm @@ -0,0 +1,109 @@ + + + + + + + + + + + +XmTextFieldInsertWcs +library call + + +XmTextFieldInsertWcs +A TextField function that inserts a wide +character string into a TextField widget + +XmTextFieldInsertWcs + +TextField functions +XmTextFieldInsertWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldInsertWcs + +Widget widget +XmTextPosition position +wchar_t *wcstring + + + +DESCRIPTION +XmTextFieldInsertWcs inserts a wide character string into +the TextField widget at a specified location. The character +positions begin at 0 (zero) and are numbered sequentially from the +beginning of the text. For example, to insert a string after +the fourth character, the position parameter must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +position, the XmNmotionVerifyCallback is called. + + + +widget + +Specifies the TextField widget ID + + + + +position + +Specifies the position in the text string where the new character string is +to be inserted + + + + +wcstring + +Specifies the wide character string value to be added to the TextField widget + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldInsert;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAT.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAT.sgm new file mode 100644 index 00000000..da2d602d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAT.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmTextFieldPaste +library call + + +XmTextFieldPaste +A TextField function that inserts the clipboard selection + +XmTextFieldPaste + +TextField functions +XmTextFieldPaste + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldPaste + +Widget widget + + + +DESCRIPTION +XmTextFieldPaste inserts the clipboard selection at the +insertion cursor of the destination widget. +If XmNpendingDelete is True and the insertion cursor is inside +the current selection, the clipboard selection replaces the selected text. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. + +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmCOPY. +If the XmNcursorPosition resource is greater than or is the same value as +the position where the selection is to be inserted, the +XmNmotionVerifyCallback is called. + + + +widget + +Specifies the TextField widget ID. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN + +This function returns False if no transfers take place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAU.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAU.sgm new file mode 100644 index 00000000..6f0cc6ea --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAU.sgm @@ -0,0 +1,80 @@ + + + + + + + + + + + +XmTextFieldPasteLink +library call + + +XmTextFieldPasteLink +A TextField function that inserts a link to the clipboard selection + +XmTextFieldPasteLink + +TextField functions +XmTextFieldPasteLink + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldPasteLink + +Widget widget + + + +DESCRIPTION +XmTextFieldPasteLink inserts a link to the clipboard selection at +the insertion cursor. +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmLINK. +The TextField widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the clipboard selection and for taking any related actions. + + + +widget + +Specifies the TextField widget ID. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +This function returns False if no transfers take place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAV.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAV.sgm new file mode 100644 index 00000000..c61f6875 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAV.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmTextFieldPosToXY +library call + + +XmTextFieldPosToXY +A TextField function that accesses the x +and y position of a character position + +XmTextFieldPosToXY + +TextField functions +XmTextFieldPosToXY + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldPosToXY + +Widget widget +XmTextPosition position +Position *x +Position *y + + + +DESCRIPTION +XmTextFieldPosToXY accesses the x and y +position, relative to the upper +left corner of the TextField widget, of a given character position in the +text buffer. + + + +widget + +Specifies the TextField widget ID + + + + +position + +Specifies the character position in the text for which the x and y +position is accessed. This is an integer number of characters +from the beginning of the buffer. The first character position is 0. + + + + +x + +Specifies the pointer in which the x position is returned. +The returned position is the distance from the left side of the widget +to the left border of the character. +This value is meaningful only if the function returns True. + + + + +y + +Specifies the pointer in which the y position is returned. +The returned position is the distance from the top of the widget +to the character's baseline. +This value is meaningful only if the function returns True. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +This function returns True if the character position is displayed in the +TextField widget; otherwise, it returns False, and no x or y +value is returned. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAW.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAW.sgm new file mode 100644 index 00000000..92d790fd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAW.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmTextFieldRemove +library call + + +XmTextFieldRemove +A TextField function that deletes the primary selection + +XmTextFieldRemove + +TextField functions +XmTextFieldRemove + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +Boolean XmTextFieldRemove + +Widget widget + + + +DESCRIPTION +XmTextFieldRemove deletes the primary selected text. +If there is a selection, this routine also calls the widget's +XmNvalueChangedCallback and verification callbacks, either +XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, +or both. If both verification callback lists are registered, the +procedures of the XmNmodifyVerifyCallback list are executed +first and the resulting data is passed to the +XmNmodifyVerifyCallbackWcs callbacks. +This function may also +call the XmNmotionVerifyCallback callback. + + + +widget + +Specifies the TextField widget ID. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +This function returns False if the primary selection is NULL or if the +widget does not own the primary selection. Otherwise, it returns +True. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAX.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAX.sgm new file mode 100644 index 00000000..f1c2b032 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAX.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmTextFieldReplace +library call + + +XmTextFieldReplace +A TextField function that replaces part of a text string + +XmTextFieldReplace + +TextField functions +XmTextFieldReplace + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldReplace + +Widget widget +XmTextPosition from_pos +XmTextPosition to_pos +char * value + + + +DESCRIPTION +XmTextFieldReplace replaces part of the text string in the TextField widget. The +character positions begin at 0 (zero) and are numbered sequentially from the +beginning of the text. + +An example text replacement would be to replace +the second and third characters in the text string. To accomplish this, +the parameter from_pos must be 1 and to_pos must be 3. To +insert a string after the fourth character, both parameters, from_pos +and to_pos, must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +The XmNmotionVerifyCallback is generated if to_pos is less +than or equal to +the cursor position and the length of value is not the same as the +length of the text being replaced, or if the cursor position is between +from_pos and to_pos, and the distance from the cursor +position to from_pos is greater than the length of value. + + + +widget + +Specifies the TextField widget ID + + + + +from_pos + +Specifies the start position of the text to be replaced + + + + +to_pos + +Specifies the end position of the text to be replaced + + + + +value + +Specifies the character string value to be added to the text widget + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. +&cdeman.XmTextFieldReplaceWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAY.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAY.sgm new file mode 100644 index 00000000..9402ecc8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAY.sgm @@ -0,0 +1,120 @@ + + + + + + + + + + + +XmTextFieldReplaceWcs +library call + + +XmTextFieldReplaceWcs +A TextField function that replaces part of a +wide character string in a TextField widget + +XmTextFieldReplaceWcs + +TextField functions +XmTextFieldReplaceWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldReplaceWcs + +Widget widget +XmTextPosition from_pos +XmTextPosition to_pos +wchar_t *wcstring + + + +DESCRIPTION +XmTextFieldReplaceWcs replaces part of the wide character string +in the TextField widget. The character positions begin at 0 (zero) and are +numbered sequentially from the beginning of the text. + +An example text replacement would be to replace +the second and third characters in the text string. To accomplish this, +the parameter from_pos must be 1 and to_pos must be 3. To +insert a string after the fourth character, both parameters, +from_pos and to_pos, must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +from_pos, the XmNmotionVerifyCallback is called. + + + +widget + +Specifies the TextField widget ID + + + + +from_pos + +Specifies the start position of the text to be replaced + + + + +to_pos + +Specifies the end position of the text to be replaced + + + + +wcstring + +Specifies the wide character string value to be added to the TextField widget + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldReplace;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAZ.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAZ.sgm new file mode 100644 index 00000000..2ca3ed92 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieAZ.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextFieldSetAddMode +library call + + +XmTextFieldSetAddMode +A TextField function that sets the state of Add mode + +XmTextFieldSetAddMode + +TextField functions +XmTextFieldSetAddMode + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetAddMode + +Widget widget +Boolean state + + + +DESCRIPTION +XmTextFieldSetAddMode controls whether or not the TextField widget is in Add +mode. When the widget is in Add mode, the insert cursor can be moved +without disturbing the primary selection. + + + +widget + +Specifies the TextField widget ID + + + + +state + +Specifies whether or not the widget is in Add mode. A value of True +turns on Add mode; a value of False turns off Add mode. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBA.sgm new file mode 100644 index 00000000..ecf6ce81 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBA.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmTextFieldSetEditable +library call + + +XmTextFieldSetEditable +A TextField function that sets the edit permission + +XmTextFieldSetEditable + +TextField functions +XmTextFieldSetEditable + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetEditable + +Widget widget +Boolean editable + + + +DESCRIPTION +XmTextFieldSetEditable sets the edit permission state of the TextField widget. +When set to True, the text string can be edited. + + + +widget + +Specifies the TextField widget ID + + + + +editable + +Specifies a Boolean value that when True allows text string edits + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBB.sgm new file mode 100644 index 00000000..8aca64e9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBB.sgm @@ -0,0 +1,112 @@ + + + + + + + + + + + +XmTextFieldSetHighlight +library call + + +XmTextFieldSetHighlight +A TextField function that highlights text + +XmTextFieldSetHighlight + +TextField functions +XmTextFieldSetHighlight + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetHighlight + +Widget widget +XmTextPosition left +XmTextPosition right +XmHighlightMode mode + + + +DESCRIPTION +XmTextFieldSetHighlight highlights text between the two specified +character positions. The mode parameter determines the type of +highlighting. Highlighting text merely changes the visual appearance of +the text; it does not set the selection. + + + +widget + +Specifies the TextField widget ID + + + + +left + +Specifies the position of the left boundary of text to be highlighted. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +right + +Specifies the position of the right boundary of text to be highlighted. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +mode + +Specifies the type of highlighting to be done. A value of +XmHIGHLIGHT_NORMAL removes highlighting. A value of +XmHIGHLIGHT_SELECTED highlights the test using reverse video. A +value of XmHIGHLIGHT_SECONDARY_SELECTED highlights the text using +underlining. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBC.sgm new file mode 100644 index 00000000..327a1e22 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBC.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmTextFieldSetInsertionPosition +library call + + +XmTextFieldSetInsertionPosition +A TextField function that sets the position of the insertion cursor + +XmTextFieldSetInsertion\\%Position + +TextField functions +XmTextFieldSetInsertion\\%Position + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetInsertionPosition + +Widget widget +XmTextPosition position + + + +DESCRIPTION +XmTextFieldSetInsertionPosition sets the insertion cursor position +of the TextField widget. +This routine also calls the widget's XmNmotionVerifyCallback +callbacks if the insertion cursor position changes. + + + +widget + +Specifies the TextField widget ID + + + + +position + +Specifies the position of the insert cursor. This is an integer number +of characters from the beginning of the text buffer. The first +character position is 0 (zero). + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBD.sgm new file mode 100644 index 00000000..46bfaba8 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBD.sgm @@ -0,0 +1,94 @@ + + + + + + + + + + + +XmTextFieldSetMaxLength +library call + + +XmTextFieldSetMaxLength +A TextField function that sets the value of the current maximum allowable length of a text string entered from the keyboard + +XmTextFieldSetMaxLength + +TextField functions +XmTextFieldSetMaxLength + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetMaxLength + +Widget widget +int max_length + + + +DESCRIPTION +XmTextFieldSetMaxLength sets the value of the current maximum allowable +length of the text string in the TextField widget. The maximum allowable length +prevents the user from entering a text string from the keyboard +that is larger than this limit. +Strings that are entered using the +XmNvalue (or XmNvalueWcs) resource, or the +XmTextFieldSetString (or XmTextFieldSetStringWcs) +function ignore this resource. + + + +widget + +Specifies the TextField widget ID + + + + +max_length + +Specifies the maximum allowable length of the text string + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmText;, +&cdeman.XmTextFieldSetString;, and +&cdeman.XmTextFieldSetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBE.sgm new file mode 100644 index 00000000..de24cb84 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBE.sgm @@ -0,0 +1,110 @@ + + + + + + + + + + + +XmTextFieldSetSelection +library call + + +XmTextFieldSetSelection +A TextField function that sets the primary selection of the text + +XmTextFieldSetSelection + +TextField functions +XmTextFieldSetSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetSelection + +Widget widget +XmTextPosition first +XmTextPosition last +Time time + + + +DESCRIPTION +XmTextFieldSetSelection sets the primary selection of the text in +the widget. +It also sets the insertion cursor position to the last position of the +selection and calls the widget's XmNmotionVerifyCallback callbacks. +XmTextFieldSetSelection always generates an +XmNgainPrimaryCallback +unless it fails to take ownership of the primary text selection. + + + +widget + +Specifies the TextField widget ID + + + + +first + +Marks the first character position of the text to be selected + + + + +last + +Marks the last position of the text to be selected + + + + +time + +Specifies the time at which the selection value is desired. This should +be the same as the time of the event that triggered this +request. One source of a valid time stamp is the function +XtLastTimestampProcessed. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBF.sgm new file mode 100644 index 00000000..094c6585 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBF.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmTextFieldSetString +library call + + +XmTextFieldSetString +A TextField function that sets the string value + +XmTextFieldSetString + +TextField functions +XmTextFieldSetString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetString + +Widget widget +char * value + + + +DESCRIPTION +XmTextFieldSetString sets the string value of the TextField widget. +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +It also sets the insertion cursor position to the beginning of the +string and calls the widget's XmNmotionVerifyCallback callbacks. + + + +widget + +Specifies the TextField widget ID + + + + +value + +Specifies the character pointer to the string value and places +the string into the text edit window + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldSetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBG.sgm new file mode 100644 index 00000000..9947c1b9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBG.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmTextFieldSetStringWcs +library call + + +XmTextFieldSetStringWcs +A TextField function that sets a wide +character string value + +XmTextFieldSetStringWcs + +TextField functions +XmTextFieldSetStringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldSetStringWcs + +Widget widget +wchar_t *wcstring + + + +DESCRIPTION +XmTextFieldSetStringWcs sets the wide character string value +of the TextField widget. This routine calls the widget's +XmNvalueChangedCallback and verification callbacks, either +XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, +or both. If both verification callback lists are registered, the +procedures of the XmNmodifyVerifyCallback list are executed +first and the resulting data is passed to the +XmNmodifyVerifyCallbackWcs callbacks. It also sets the insertion +cursor position to the beginning of the string and calls the widget's +XmNmotionVerifyCallback callbacks. + + + +widget + +Specifies the TextField widget ID + + + + +wcstring + +Specifies the wide character string value + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; and +&cdeman.XmTextFieldSetString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBH.sgm new file mode 100644 index 00000000..7aa2f7c9 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBH.sgm @@ -0,0 +1,91 @@ + + + + + + + + + + + +XmTextFieldShowPosition +library call + + +XmTextFieldShowPosition +A TextField function that forces text at a given position to be displayed + +XmTextFieldShowPosition + +TextField functions +XmTextFieldShowPosition + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +void XmTextFieldShowPosition + +Widget widget +XmTextPosition position + + + +DESCRIPTION +XmTextFieldShowPosition forces text at the specified position to be +displayed. +The cursor position is not updated nor is the cursor shown at this position. + + + +widget + +Specifies the TextField widget ID + + + + +position + +Specifies the character position to be displayed. This is an integer +number of characters from the beginning of the text buffer. The first +character position is 0 (zero). +See &cdeman.XmTextPosition; for details on the +XmTextPosition data type. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RELATED +&cdeman.XmTextField; +and +&cdeman.XmTextPosition;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBI.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBI.sgm new file mode 100644 index 00000000..f85854c4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFieBI.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmTextFieldXYToPos +library call + + +XmTextFieldXYToPos +A TextField function that accesses the character position nearest an x and y position + +XmTextFieldXYToPos + +TextField functions +XmTextFieldXYToPos + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/TextF.h> + +XmTextPosition XmTextFieldXYToPos + +Widget widget +Position x +Position y + + + +DESCRIPTION +XmTextFieldXYToPos accesses the character position nearest to the +specified x and y position, relative to the upper left corner of the +TextField widget. + + + +widget + +Specifies the TextField widget ID + + + + +x + +Specifies the x position, relative to the upper left corner of the +widget. + + + + +y + +Specifies the y position, relative to the upper left corner of the +widget. + + + + +For a complete definition of TextField and its associated resources, see +&cdeman.XmTextField;. + + + +RETURN +Returns the character position in the text nearest the x and y +position specified. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + +RELATED +&cdeman.XmTextField;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindA.sgm new file mode 100644 index 00000000..5ef57403 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindA.sgm @@ -0,0 +1,146 @@ + + + + + + + + + + + +XmTextFindString +library call + + +XmTextFindString +A Text function that finds the beginning position of a text string + +XmTextFindString + +Text functions +XmTextFindString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmTextFindString + +Widget widget +XmTextPosition start +char *string +XmTextDirection direction +XmTextPosition *position + + + +DESCRIPTION +XmTextFindString locates the beginning position of a specified +text string. This routine searches forward or backward for the first +occurrence of the string starting from the given start position. +If it finds a match, the function +returns the position of the first character of the string in position. +If the match string begins at the current position, this routine returns the current position. + + + +widget + +Specifies the Text widget ID. + + + + +start + +Specifies the character position from which the search proceeds. This +is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +string + +Specifies the search string. + + + + +direction + +Indicates the search direction. It is relative to the primary +direction of the text. The possible values are + + + +XmTEXT_FORWARD + +The search proceeds toward the end of the text buffer. + + + + +XmTEXT_BACKWARD + +The search proceeds toward the beginning of the text buffer. + + + + + + + +position + +Specifies the pointer in which the first character position +of the string match is returned. This is an integer number +of characters from the beginning of the buffer. The first +character position is 0 (zero). If the function returns False, +this value is undefined. + + + + +For a complete definition of Text and its associated resources, +see &cdeman.XmText;. + + + +RETURN +Returns True if a string match is found; otherwise, returns False. + + + +RELATED +&cdeman.XmText; and &cdeman.XmTextFindStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindB.sgm new file mode 100644 index 00000000..6b0a2ea0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtFindB.sgm @@ -0,0 +1,148 @@ + + + + + + + + + + + +XmTextFindStringWcs +library call + + +XmTextFindStringWcs +A Text function that finds the beginning +position of a wide character text string + +XmTextFindStringWcs + +Text functions +XmTextFindStringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextFindStringWcs + +Widget widget +XmTextPosition start +wchar_t *wcstring +XmTextDirection direction +XmTextPosition *position + + + +DESCRIPTION +XmTextFindStringWcs locates the beginning position of a specified +wide character text string. This routine searches forward or backward +for the first occurrence of the string, starting from the given start +position. +If a match is found, the +function returns the position of the first character of the string +in position. +If the match string begins at the current position, this routine returns the current position. + + +widget + +Specifies the Text widget ID. + + + + +start + +Specifies the character position from which the search proceeds. This +is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +wcstring + +Specifies the wide character search string. + + + + +direction + +Indicates the search direction. It is relative to the primary direction +of the text. The possible values are + + + +XmTEXT_FORWARD + +The search proceeds toward the end of the buffer. + + + + +XmTEXT_BACKWARD + +The search proceeds toward the beginning of the buffer. + + + + + + + +position + +Specifies the pointer in which the first character position +of the string match is returned. +This is an integer number of characters from the beginning of +the buffer. The first character position is 0 (zero). If the function +returns False, this value is undefined. + + + + +For a complete definition of Text and its associated resources, +see &cdeman.XmText;. + + + +RETURN +Returns True if a string match is found; otherwise, returns False. + + + +RELATED +&cdeman.XmText; and &cdeman.XmTextFindString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetBa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetBa.sgm new file mode 100644 index 00000000..e90265a7 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetBa.sgm @@ -0,0 +1,74 @@ + + + + + + + + + + +XmTextGetBaseline +library call + + +XmTextGetBaseline +A Text function that accesses the y position of the baseline + +XmTextGetBaseline + +Text functions +XmTextGetBaseline + + + + +#include <Xm/Text.h> + +int XmTextGetBaseline +Widget widget + + + +DESCRIPTION +XmTextGetBaseline accesses the y position of the +baseline in the Text widget, +relative to the y position of the top of the widget. + + +In vertical mode (when the XmNlayoutDirection resource is +XmTOP_TO_BOTTOM) this function returns 0 and +the program should use XmTextGetCenterline + + + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns an integer value that indicates the y position +of the baseline in the Text widget. +The calculation takes into account the +margin height, shadow thickness, highlight thickness, and font ascent of +the first font (set) in the fontlist used for drawing text. +In this calculation, the +y position of the top of the widget is 0 (zero). + + + +RELATED +&cdeman.XmText;, &cdeman.XmTextGetCenterline;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetCl.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetCl.sgm new file mode 100644 index 00000000..05456bb4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetCl.sgm @@ -0,0 +1,56 @@ + + + + + + + + + + +XmTextGetCenterline +library call + + +XmTextGetCenterline + +Return the height (length) of a character string +when the writing direction is vertical + + + + +#include <Xm/Text.h> + +int XmTextGetCenterline +Widget widget + + + +DESCRIPTION +XmTextGetCenterline accesses the x position of the centerline in the +Text widget, relative to the x position of the top of the widget. + + +widget + +Specifies the Text widget ID. + + + + + +RETURN VALUEIn the case of horizontal writing, this function accesses 0. +In the case of vertical writing, this function accesses the +x position of the first centerline in the Text widget, +relative to the x position of the left of the widget. +The calculation takes into account the margin width, shadow +thickness, highlight thickness, and a half of font width of +the first font(set) in the fontlist used for drawing text. + + +SEE ALSO +&cdeman.XmText;, &cdeman.XmTextGetBaseline; + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetEd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetEd.sgm new file mode 100644 index 00000000..46afa83f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetEd.sgm @@ -0,0 +1,83 @@ + + + + + + + + + + + +XmTextGetEditable +library call + + +XmTextGetEditable +A Text function that accesses the edit permission state + +XmTextGetEditable + +Text functions +XmTextGetEditable + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextGetEditable + +Widget widget + + + +DESCRIPTION +XmTextGetEditable accesses the edit permission state of the Text widget. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns a Boolean value that indicates the state of the XmNeditable +resource. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetIn.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetIn.sgm new file mode 100644 index 00000000..4a60737e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetIn.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmTextGetInsertionPosition +library call + + +XmTextGetInsertionPosition +A Text function that accesses the position of the insert cursor + +XmTextGetInsertionPosition + +Text functions +XmTextGetInsertionPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +XmTextPosition XmTextGetInsertionPosition + +Widget widget + + + +DESCRIPTION +XmTextGetInsertionPosition accesses the insertion cursor position of the +Text widget. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns an XmTextPosition value that indicates the state of the +XmNcursorPosition resource. This is an integer number of +characters from the beginning of the text buffer. The first character +position is 0 (zero). + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetLa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetLa.sgm new file mode 100644 index 00000000..87ba7ac5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetLa.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmTextGetLastPosition +library call + + +XmTextGetLastPosition +A Text function that accesses the last position in the text + +XmTextGetLastPosition + +Text functions +XmTextGetLastPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +XmTextPosition XmTextGetLastPosition + +Widget widget + + + +DESCRIPTION +XmTextGetLastPosition accesses the last position +in the text buffer of the Text widget. This is an integer +number of characters from the beginning of the buffer, and +represents the position that text added to the end +of the buffer is placed after. The first character position is 0 (zero). +The last character position is equal to the number of characters +in the text buffer. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns an XmTextPosition value that indicates the last position +in the text buffer. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetMa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetMa.sgm new file mode 100644 index 00000000..e3a41d72 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetMa.sgm @@ -0,0 +1,87 @@ + + + + + + + + + + + +XmTextGetMaxLength +library call + + +XmTextGetMaxLength +A Text function that accesses the value of the current maximum allowable length of a text string entered from the keyboard + +XmTextGetMaxLength + +Text functions +XmTextGetMaxLength + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +int XmTextGetMaxLength + +Widget widget + + + +DESCRIPTION +XmTextGetMaxLength accesses the value of the current maximum allowable +length of the text string in the Text widget entered from the +keyboard. The maximum allowable length +prevents the user from entering a text string larger than this limit. +Note that the maximum allowable length is the same as the value +of the widget's XmNmaxLength resource. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the integer value that indicates the string's maximum allowable +length that can be entered from the keyboard. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSA.sgm new file mode 100644 index 00000000..7b35374c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSA.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextGetSelection +library call + + +XmTextGetSelection +A Text function that retrieves the value of the primary selection + +XmTextGetSelection + +Text functions +XmTextGetSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +char * XmTextGetSelection + +Widget widget + + + +DESCRIPTION +XmTextGetSelection +retrieves the value of the primary selection. It returns +a NULL pointer if no text is selected in the widget. The application is +responsible for freeing the storage associated with the string by calling +XtFree. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns a character pointer to the string that is associated with the +primary selection. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextGetSelectionWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSB.sgm new file mode 100644 index 00000000..77627682 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSB.sgm @@ -0,0 +1,104 @@ + + + + + + + + + + + +XmTextGetSelectionPosition +library call + + +XmTextGetSelectionPosition +A Text function that accesses the position of the primary selection + +XmTextGetSelectionPosition + +Text functions +XmTextGetSelectionPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextGetSelectionPosition + +Widget widget +XmTextPosition *left +XmTextPosition *right + + + +DESCRIPTION +XmTextGetSelectionPosition accesses the left and right position of +the primary selection in the text buffer of the Text widget. + + + +widget + +Specifies the Text widget ID + + + + +left + +Specifies the pointer in which the position of the left boundary of the +primary selection is returned. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + + +right + +Specifies the pointer in which the position of the right boundary of the +primary selection is returned. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +This function returns True if the widget owns the primary selection; +otherwise, it returns False. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSC.sgm new file mode 100644 index 00000000..dd1285f2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSC.sgm @@ -0,0 +1,89 @@ + + + + + + + + + + + +XmTextGetSelectionWcs +library call + + +XmTextGetSelectionWcs +A Text function that retrieves the +value of a wide character encoded primary selection + +XmTextGetSelectionWcs + +Text functions +XmTextGetSelectionWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +wchar_t * XmTextGetSelectionWcs + +Widget widget + + + +DESCRIPTION +XmTextGetSelectionWcs retrieves the value of the primary selection +that is encoded in a wide character format. It returns a NULL pointer +if no text is selected in the widget. The application is responsible +for freeing the storage associated with the wide character buffer by +calling XtFree. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the wide character string that is associated with the +primary selection in the Text widget. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextGetSelection;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSD.sgm new file mode 100644 index 00000000..3380a7c5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSD.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmTextGetSource +library call + + +XmTextGetSource +A Text function that accesses the source of the widget + +XmTextGetSource + +Text functions +XmTextGetSource + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +XmTextSource XmTextGetSource + +Widget widget + + + +DESCRIPTION +XmTextGetSource accesses the source of the Text widget. Text +widgets can share sources of text so that editing in one widget is +reflected in another. This function accesses the source of one widget +so that it can be made the source of another widget, using the function +&cdeman.XmTextSetSource;. + +Setting a new text source destroys the old text source if no other Text +widgets are using that source. +To replace a text source but keep it for later use, create an unmanaged +Text widget and set its source to the text source you want to keep. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns an XmTextSource value that represents the source of the Text +widget. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSE.sgm new file mode 100644 index 00000000..8669d5ed --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSE.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextGetString +library call + + +XmTextGetString +A Text function that accesses the string value + +XmTextGetString + +Text functions +XmTextGetString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +char * XmTextGetString + +Widget widget + + + +DESCRIPTION +XmTextGetString +accesses the string value of the Text widget. The application +is responsible for freeing the storage associated with the string by +calling XtFree. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns a character pointer to the string value of the text widget. +This returned value is a copy of the value of the XmNvalue resource. +Returns an empty string if the length of the Text widget's string is 0 (zero). + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextGetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSF.sgm new file mode 100644 index 00000000..d442f9cd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSF.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextGetStringWcs +library call + + +XmTextGetStringWcs +A Text function that retrieves a copy +of the wide character string value of a Text widget + +XmTextGetStringWcs + +Text functions +XmTextGetStringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +wchar_t * XmTextGetStringWcs + +Widget widget + + + +DESCRIPTION +XmTextGetStringWcs retrieves a copy of the wide character string value +of the Text widget. The application is responsible for freeing +the storage associated with the string by calling XtFree. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the wide character string value of the Text widget. The +function returns an empty string if the length of the Text widget's +string is 0 (zero). + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextGetString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSG.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSG.sgm new file mode 100644 index 00000000..12262c75 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSG.sgm @@ -0,0 +1,162 @@ + + + + + + + + + + + +XmTextGetSubstring +library call + + +XmTextGetSubstring +A Text function that retrieves a copy +of a portion of the internal text buffer + +XmTextGetSubstring + +Text functions +XmTextGetSubstring + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +int XmTextGetSubstring + +Widget widget +XmTextPosition start +int num_chars +int buffer_size +char *buffer + + + +DESCRIPTION +XmTextGetSubstring retrieves a copy of a portion of the internal +text buffer of a Text widget. The function +copies a specified number of characters from a given start position +in the internal text buffer into a buffer provided by the +application. A NULL terminator is placed at the end of the copied data. + +The size of the required buffer depends on the maximum number of bytes +per character (MB_CUR_MAX) for the current locale. +MB_CUR_MAX is a macro defined in stdlib.h. The buffer +should be large enough to contain the substring to be copied and +a NULL terminator. Use the following equation to calculate the +size of buffer the application should provide: + + +buffer_size = (num_chars* MB_CUR_MAX) + 1 + + + + + +widget + +Specifies the Text widget ID. + + + + +start + +Specifies the beginning character position from which the data will be +retrieved. This is an integer number of characters from the beginning +of the text buffer. The first character position is 0 (zero). + + + + +num_chars + +Specifies the number of characters to be copied into the provided buffer. + + + + +buffer_size + +Specifies the size of the supplied buffer in bytes. This size +should account for a NULL terminator. + + + + +buffer + +Specifies the character buffer into which the internal +text buffer will be copied. + + + + +For a complete definition of Text and its associated resources, +see &cdeman.XmText;. + + + +RETURN + + +XmCOPY_SUCCEEDED + +The function was successful. + + + + +XmCOPY_FAILED + +The function failed because it was unable to copy the +specified number of characters into the buffer provided. +The buffer size may be insufficient. The contents of +buffer are undefined. + + + + +XmCOPY_TRUNCATED + +The requested number of characters extended beyond the internal +buffer. The function copied characters between start and the +end of the widget's buffer and terminated the string with a NULL +terminator; fewer than num_chars characters were copied. + + + + + + +RELATED +&cdeman.XmText; and &cdeman.XmTextGetSubstringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSH.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSH.sgm new file mode 100644 index 00000000..6cee34d1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetSH.sgm @@ -0,0 +1,152 @@ + + + + + + + + + + + +XmTextGetSubstringWcs +library call + + +XmTextGetSubstringWcs +A Text function that retrieves +a portion of a wide character internal text buffer + +XmTextGetSubstringWcs + +Text functions +XmTextGetSubstringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +int XmTextGetSubstringWcs + +Widget widget +XmTextPosition start +int num_chars +int buffer_size +wchar_t *buffer + + + +DESCRIPTION +XmTextGetSubstringWcs retrieves a copy of a portion of the internal +text buffer of a Text widget that is stored in a wide character +format. The function copies a specified number of characters from +a given start position in the internal text buffer into a buffer +provided by the application. A NULL terminator is placed at the +end of the copied data. + + + +widget + +Specifies the Text widget ID. + + + + +start + +Specifies the beginning character position from which the data will be +retrieved. This is an integer number of characters from the beginning of +the text buffer. The first character position is 0 (zero). + + + + +num_chars + +Specifies the number of wchar_t characters to be copied into +the provided buffer. + + + + +buffer_size + +Specifies the size of the supplied buffer as a number of wchar_t +storage locations. The minimum size is num_chars + 1. + + + + +buffer + +Specifies the wide character buffer into which the internal +text buffer will be copied. + + + + +For a complete definition of Text and its associated resources, +see &cdeman.XmText;. + + + +RETURN + + +XmCOPY_SUCCEEDED + +The function was successful. + + + + +XmCOPY_FAILED + +The function failed because it was unable to copy the +specified number of characters into the buffer provided. +The buffer size may be insufficient. The contents of +buffer are undefined. + + + + +XmCOPY_TRUNCATED + +The requested number of characters extended beyond the internal +buffer. The function copied characters between start and the +end of the widget's buffer and terminated the string with a NULL +terminator; fewer than num_chars characters were copied. + + + + + + +RELATED +&cdeman.XmText; and &cdeman.XmTextGetSubstring;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetTo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetTo.sgm new file mode 100644 index 00000000..00e4d6b0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtGetTo.sgm @@ -0,0 +1,98 @@ + + + + + + + + + + + +XmTextGetTopCharacter +library call + + +XmTextGetTopCharacter +A Text function that accesses the position of the first character displayed + +XmTextGetTopCharacter + +Text functions +XmTextGetTopCharacter + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +XmTextPosition XmTextGetTopCharacter + +Widget widget + + + +DESCRIPTION +XmTextGetTopCharacter accesses the position of the text at the top +of the Text widget. +If there is no text in the Text widget (in other words, +XmNvalue contains an empty string), +then XmTextGetTopCharacter returns 0. + +Suppose that the XmNtopCharacter resource has been +set to a value greater than the number of characters in +the text widget. In this case, +XmTextGetTopCharacter returns an +XmTextPosition value identifying +the position of the first character in the last line of text in a +multiline case; otherwise, it identifies the position of the last +character in the line. + + + +widget + +Specifies the Text widget ID + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns an XmTextPosition value that indicates the state of the +XmNtopCharacter resource. This is an integer number of characters +from the beginning of the text buffer. The first character position is +0 (zero). + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseA.sgm new file mode 100644 index 00000000..ed6264ab --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseA.sgm @@ -0,0 +1,111 @@ + + + + + + + + + + + +XmTextInsert +library call + + +XmTextInsert +A Text function that inserts a character string into a text string + +XmTextInsert + +Text functions +XmTextInsert + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextInsert + +Widget widget +XmTextPosition position +char * value + + + +DESCRIPTION +XmTextInsert inserts a character string into the text string in +the Text widget. The character positions begin at 0 (zero) and are numbered +sequentially from the beginning of the text. For example, to insert a +string after the fourth character, the parameter position must be +4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +position, the XmNmotionVerifyCallback is called. + +Note that, if value is a null string, no callbacks will be +generated, since no modifications will have been made. + + + +widget + +Specifies the Text widget ID. + + + + +position + +Specifies the position in the text string where the character string is +to be inserted. + + + + +value + +Specifies the character string value to be added to the text widget. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextInsertWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseB.sgm new file mode 100644 index 00000000..03d7b8fc --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtInseB.sgm @@ -0,0 +1,113 @@ + + + + + + + + + + + +XmTextInsertWcs +library call + + +XmTextInsertWcs +A Text function that inserts a wide character +string into a Text widget + +XmTextInsertWcs + +Text functions +XmTextInsertWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextInsertWcs + +Widget widget +XmTextPosition position +wchar_t *wcstring + + + +DESCRIPTION +XmTextInsertWcs inserts a wide character string into +the Text widget at a specified location. The character +positions begin at 0 (zero) and are numbered sequentially from +the beginning of the text. For example, to insert a string +after the fourth character, the position parameter +must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +position, the XmNmotionVerifyCallback is called. + +Note that, if value is a null string, no callbacks will be +generated, since no modifications will have been made. + + + +widget + +Specifies the Text widget ID + + + + +position + +Specifies the position in the text string where the new character string is +to be inserted + + + + +wcstring + +Specifies the wide character string value to be added to the Text widget + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextInsert;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastA.sgm new file mode 100644 index 00000000..7e3a30b2 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastA.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + + +XmTextPaste +library call + + +XmTextPaste +A Text function that inserts the clipboard selection + +XmTextPaste + +Text functions +XmTextPaste + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextPaste + +Widget widget + + + +DESCRIPTION +XmTextPaste inserts the clipboard selection at the insertion cursor +of the destination widget. +If XmNpendingDelete is True and the insertion cursor is inside +the current selection, the clipboard selection replaces the selected text. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the +resulting data is passed to the XmNmodifyVerifyCallbackWcs +callbacks. +If the XmNcursorPosition resource is greater than or is the same value as +the position where the selection is to be inserted, the +XmNmotionVerifyCallback is called. + +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmCOPY. + + + +widget + +Specifies the Text widget ID. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN + +This function returns False if no transfers take place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastB.sgm new file mode 100644 index 00000000..0f7e0047 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPastB.sgm @@ -0,0 +1,78 @@ + + + + + + + + + + + +XmTextPasteLink +library call + + +XmTextPasteLink +A Text function that inserts a link to the clipboard selection + +XmTextPasteLink + +Text functions +XmTextPasteLink + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextPasteLink + +Widget widget + + + +DESCRIPTION +XmTextPasteLink inserts a link to the clipboard selection at the +insertion cursor. +This routine calls the widget's XmNdestinationCallback procedures +with the selection member of the XmDestinationCallbackStruct +set to CLIPBOARD and with the operation member set to +XmLINK. +The Text widget itself performs no transfers; the +XmNdestinationCallback procedures are responsible for inserting +the link to the clipboard selection and for taking any related actions. + + + +widget + +Specifies the Text widget ID. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +This function returns False if no transfers take place. +Otherwise, it returns True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosTo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosTo.sgm new file mode 100644 index 00000000..e76e724d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosTo.sgm @@ -0,0 +1,101 @@ + + + + + + + + + + +XmTextPosToXY +library call + + +XmTextPosToXY +A Text function that accesses the x and y position of a character position + +XmTextPosToXY + +Text functions +XmTextPosToXY + + + + +#include <Xm/Text.h> + +Boolean XmTextPosToXY +Widget widget +XmTextPosition position +Position *x +Position *y + + + +DESCRIPTION +XmTextPosToXY accesses the x and y position, +relative to the upper +left corner of the Text widget, of a given character position in the +text buffer. + +In the case of horizontal writing, the position is the origin of the +character. In the case of vertical writing, the position is the vertical +origin of the character. + + + +widget + +Specifies the Text widget ID + + + + +position + +Specifies the character position in the text for which the x and y +position is accessed. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + + +x + +Specifies the pointer in which the x position is returned. +The returned position is the distance from the left side of the widget +to the left border of the character. +This value is meaningful only if the function returns True. + + + + +y + +Specifies the pointer in which the y position is returned. +The returned position is the distance from the top of the widget +to the character's baseline. +This value is meaningful only if the function returns True. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +This function returns True if the character position is displayed in the +Text widget; otherwise, it returns False, and no x or y +value is returned. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosit.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosit.sgm new file mode 100644 index 00000000..533b2087 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtPosit.sgm @@ -0,0 +1,72 @@ + + + + + + + + + + + +XmTextPosition +library call + + +XmTextPosition +Data type for a character position within a text string + +XmTextPosition + +data types +XmTextPosition + + + + + + + + + + + + + + + + + + + + + + + +&npzwc;#include <Xm/Xm.h> + + + +DESCRIPTION +XmTextPosition +is an integer data type that holds a character's position within +a text string for +Text and TextField. + +An XmTextPosition value conceptually points to the gap +between two characters. +For example, consider a text string consisting of N characters. +A value of 0 refers to the position immediately prior to the first character. +A value of 1 refers to the position in between the first and second characters. +A value of N refers to the position immediately following the last +character. Therefore, the text string of N characters +actually contains N + 1 positions. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtRemov.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtRemov.sgm new file mode 100644 index 00000000..b5f74c9d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtRemov.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmTextRemove +library call + + +XmTextRemove +A Text function that deletes the primary selection + +XmTextRemove + +Text functions +XmTextRemove + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +Boolean XmTextRemove + +Widget widget + + + +DESCRIPTION +XmTextRemove deletes the primary selected text. +If there is a selection, this routine also calls the widget's +XmNvalueChangedCallback and verification callbacks, either +XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, +or both. If both verification callback lists are registered, the +procedures of the XmNmodifyVerifyCallback list are executed +first and the resulting data is passed to the +XmNmodifyVerifyCallbackWcs callbacks. +This function may also +call the XmNmotionVerifyCallback callback. + + + +widget + +Specifies the Text widget ID. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +This function returns False if the primary selection is NULL or if the +widget does not own the primary selection. Otherwise, it returns +True. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplA.sgm new file mode 100644 index 00000000..9e5a1234 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplA.sgm @@ -0,0 +1,123 @@ + + + + + + + + + + + +XmTextReplace +library call + + +XmTextReplace +A Text function that replaces part of a text string + +XmTextReplace + +Text functions +XmTextReplace + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextReplace + +Widget widget +XmTextPosition from_pos +XmTextPosition to_pos +char * value + + + +DESCRIPTION +XmTextReplace replaces part of the text string in the Text widget. The +character positions begin at 0 (zero) and are numbered sequentially from the +beginning of the text. + +An example text replacement would be to replace +the second and third characters in the text string. To accomplish this, +the parameter from_pos must be 1 and to_pos must be 3. To +insert a string after the fourth character, both parameters, from_pos +and to_pos, must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +The XmNmotionVerifyCallback is generated if to_pos is less +than or equal to +the cursor position and the length of value is not the same as the +length of the text being replaced, or if the cursor position is between +from_pos and to_pos, and the distance from the cursor +position to from_pos is greater than the length of value. + + + +widget + +Specifies the Text widget ID + + + + +from_pos + +Specifies the start position of the text to be replaced + + + + +to_pos + +Specifies the end position of the text to be replaced + + + + +value + +Specifies the character string value to be added to the text widget + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextReplaceWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplB.sgm new file mode 100644 index 00000000..1c8a46f5 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtReplB.sgm @@ -0,0 +1,121 @@ + + + + + + + + + + + +XmTextReplaceWcs +library call + + +XmTextReplaceWcs +A Text function that replaces part of +a wide character string in a Text widget + +XmTextReplaceWcs + +Text functions +XmTextReplaceWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextReplaceWcs + +Widget widget +XmTextPosition from_pos +XmTextPosition to_pos +wchar_t *wcstring + + + +DESCRIPTION +XmTextReplaceWcs replaces part of the wide character +string in the Text widget. The character positions begin at +zero and are numbered sequentially from the beginning of the text. + +An example text replacement would be to replace +the second and third characters in the text string. To accomplish this, +the from_pos parameter must be 1 and the to_pos +parameter must be 3. To +insert a string after the fourth character, both the +from_pos and to_pos parameters must be 4. + +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +This routine calls the widget's XmNmotionVerifyCallback callback +when from_pos is less than or equal to the cursor position. + + + +widget + +Specifies the Text widget ID + + + + +from_pos + +Specifies the start position of the text to be replaced + + + + +to_pos + +Specifies the end position of the text to be replaced + + + + +wcstring + +Specifies the wide character string value to be added to the Text widget + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextReplace;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtScrol.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtScrol.sgm new file mode 100644 index 00000000..a4daebd4 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtScrol.sgm @@ -0,0 +1,75 @@ + + + + + + + + + + +XmTextScroll +library call + + +XmTextScroll +A Text function that scrolls text + +XmTextScroll + +Text functions +XmTextScroll + + + + +#include <Xm/Text.h> + +void XmTextScroll +Widget widget +int lines + + + +DESCRIPTION +XmTextScroll scrolls text by a given number +of lines in a Text widget. The sign of the number is interpreted +according to the value of the XmNlayoutDirection resource. + + + +widget + +Specifies the Text widget ID + + + + +lines + +Specifies the number of lines of text to scroll. A positive value +causes text to scroll upward; a negative value causes text to scroll +downward. +Note that the text will scroll only as long as one line of text +remains visible in the window. + +If a navigator exists, this function uses the XmQTnavigator +trait to update the vertical navigator's value. + +In the case of vertical writing, a positive value causes the text to scroll forward; +a negative value causes the lines to scroll backward. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetAd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetAd.sgm new file mode 100644 index 00000000..607317fd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetAd.sgm @@ -0,0 +1,88 @@ + + + + + + + + + + + +XmTextSetAddMode +library call + + +XmTextSetAddMode +A Text function that sets the state of Add mode + +XmTextSetAddMode + +Text functions +XmTextSetAddMode + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetAddMode + +Widget widget +Boolean state + + + +DESCRIPTION +XmTextSetAddMode controls whether or not the Text widget is in Add +mode. When the widget is in Add mode, the insert cursor can be moved +without disturbing the primary selection. + + + +widget + +Specifies the Text widget ID + + + + +state + +Specifies whether or not the widget is in Add mode. A value of True +turns on Add mode; a value of False turns off Add mode. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetEd.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetEd.sgm new file mode 100644 index 00000000..7e072d75 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetEd.sgm @@ -0,0 +1,86 @@ + + + + + + + + + + + +XmTextSetEditable +library call + + +XmTextSetEditable +A Text function that sets the edit permission + +XmTextSetEditable + +Text functions +XmTextSetEditable + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetEditable + +Widget widget +Boolean editable + + + +DESCRIPTION +XmTextSetEditable sets the edit permission state of the Text widget. +When set to True, the text string can be edited. + + + +widget + +Specifies the Text widget ID + + + + +editable + +Specifies a Boolean value that when True allows text string edits + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetHi.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetHi.sgm new file mode 100644 index 00000000..a649239f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetHi.sgm @@ -0,0 +1,112 @@ + + + + + + + + + + + +XmTextSetHighlight +library call + + +XmTextSetHighlight +A Text function that highlights text + +XmTextSetHighlight + +Text functions +XmTextSetHighlight + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetHighlight + +Widget widget +XmTextPosition left +XmTextPosition right +XmHighlightMode mode + + + +DESCRIPTION +XmTextSetHighlight highlights text between the two specified +character positions. The mode parameter determines the type of +highlighting. Highlighting text merely changes the visual appearance of +the text; it does not set the selection. + + + +widget + +Specifies the Text widget ID + + + + +left + +Specifies the position of the left boundary of text to be highlighted. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +right + +Specifies the position of the right boundary of text to be highlighted. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +mode + +Specifies the type of highlighting to be done. A value of +XmHIGHLIGHT_NORMAL removes highlighting. A value of +XmHIGHLIGHT_SELECTED highlights the text using reverse video. A +value of XmHIGHLIGHT_SECONDARY_SELECTED highlights the text using +underlining. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetIn.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetIn.sgm new file mode 100644 index 00000000..342c3dcd --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetIn.sgm @@ -0,0 +1,90 @@ + + + + + + + + + + + +XmTextSetInsertionPosition +library call + + +XmTextSetInsertionPosition +A Text function that sets the position of the insert cursor + +XmTextSetInsertionPosition + +Text functions +XmTextSetInsertionPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetInsertionPosition + +Widget widget +XmTextPosition position + + + +DESCRIPTION +XmTextSetInsertionPosition sets the insertion cursor position of the +Text widget. +This routine also calls the widget's XmNmotionVerifyCallback +callbacks if the insertion cursor position changes. + + + +widget + +Specifies the Text widget ID + + + + +position + +Specifies the position of the insertion cursor. This is an integer number +of characters from the beginning of the text buffer. The first +character position is 0 (zero). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetMa.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetMa.sgm new file mode 100644 index 00000000..280b4b3e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetMa.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmTextSetMaxLength +library call + + +XmTextSetMaxLength +A Text function that sets the value of the current maximum allowable length of a text string entered from the keyboard + +XmTextSetMaxLength + +Text functions +XmTextSetMaxLength + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetMaxLength + +Widget widget +int max_length + + + +DESCRIPTION +XmTextSetMaxLength sets the value of the current maximum allowable +length of the text string in the Text widget. The maximum allowable length +prevents the user from entering a text string from the keyboard +that is larger than this limit. +Strings that are entered using the XmNvalue (or XmNvalueWcs) +resource, or the XmTextSetString (or XmTextSetStringWcs) +function ignore this resource. + + + +widget + +Specifies the Text widget ID + + + + +max_length + +Specifies the maximum allowable length of the text string + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;, +&cdeman.XmTextSetString;, and +&cdeman.XmTextSetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSA.sgm new file mode 100644 index 00000000..a3f8473e --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSA.sgm @@ -0,0 +1,107 @@ + + + + + + + + + + + +XmTextSetSelection +library call + + +XmTextSetSelection +A Text function that sets the primary selection of the text + +XmTextSetSelection + +Text functions +XmTextSetSelection + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetSelection + +Widget widget +XmTextPosition first +XmTextPosition last +Time time + + + +DESCRIPTION +XmTextSetSelection sets the primary selection of the text in the +widget. +It also sets the insertion cursor position to the last position of the +selection and calls the widget's XmNmotionVerifyCallback callbacks. + + + +widget + +Specifies the Text widget ID + + + + +first + +Marks the first character position of the text to be selected + + + + +last + +Marks the last position of the text to be selected + + + + +time + +Specifies the time at which the selection value is desired. This should +be the same as the time of the event that triggered this request. +request. One source of a valid time stamp is the function +XtLastTimestampProcessed. + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSB.sgm new file mode 100644 index 00000000..6e9f51ac --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSB.sgm @@ -0,0 +1,115 @@ + + + + + + + + + + + +XmTextSetSource +library call + + +XmTextSetSource +A Text function that sets the source of the widget + +XmTextSetSource + +Text functions +XmTextSetSource + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetSource + +Widget widget +XmTextSource source +XmTextPosition top_character +XmTextPosition cursor_position + + + +DESCRIPTION +XmTextSetSource sets the source of the Text widget. Text +widgets can share sources of text so that editing in one widget is +reflected in another. This function sets the source of one widget +so that it can share the source of another widget. + +Setting a new text source destroys the old text source if no other Text +widgets are using that source. +To replace a text source but keep it for later use, create an unmanaged +Text widget and set its source to the text source you want to keep. + + + +widget + +Specifies the Text widget ID. + + + + +source + +Specifies the source with which the widget displays text. This can be a +value returned by the &cdeman.XmTextGetSource; function. If no source +is specified, the widget creates a default string source. + + + + +top_character + +Specifies the position in the text to display at the top of the widget. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +cursor_position + +Specifies the position in the text at which the insert cursor is +located. This is an integer number of characters from the beginning of +the text buffer. The first character position is 0 (zero). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSC.sgm new file mode 100644 index 00000000..b26ac13c --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSC.sgm @@ -0,0 +1,95 @@ + + + + + + + + + + + +XmTextSetString +library call + + +XmTextSetString +A Text function that sets the string value + +XmTextSetString + +Text functions +XmTextSetString + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetString + +Widget widget +char * value + + + +DESCRIPTION +XmTextSetString sets the string value of the Text widget. +This routine calls the widget's XmNvalueChangedCallback and +verification callbacks, either XmNmodifyVerifyCallback or +XmNmodifyVerifyCallbackWcs, or both. If both verification +callback lists are registered, the procedures of the +XmNmodifyVerifyCallback list are executed first and the resulting +data is passed to the XmNmodifyVerifyCallbackWcs callbacks. +This function also sets the insertion cursor position to the beginning of the +string and calls the widget's XmNmotionVerifyCallback callbacks. + + + +widget + +Specifies the Text widget ID + + + + +value + +Specifies the character pointer to the string value and places the +string into the text edit window + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextSetStringWcs;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSD.sgm new file mode 100644 index 00000000..da301a62 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetSD.sgm @@ -0,0 +1,96 @@ + + + + + + + + + + + +XmTextSetStringWcs +library call + + +XmTextSetStringWcs +A Text function that sets a wide character +string value + +XmTextSetStringWcs + +Text functions +XmTextSetStringWcs + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetStringWcs + +Widget widget +wchar_t *wcstring + + + +DESCRIPTION +XmTextSetStringWcs sets the wide character string value +of the Text widget. This routine calls the widget's +XmNvalueChangedCallback and verification callbacks, either +XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, +or both. If both verification callback lists are registered, the +procedures of the XmNmodifyVerifyCallback list are executed +first and the resulting data is passed to the +XmNmodifyVerifyCallbackWcs callbacks. This function also sets the +insertion cursor position to the beginning of the string and +calls the widget's XmNmotionVerifyCallback callbacks. + + + +widget + +Specifies the Text widget ID + + + + +value + +Specifies the wide character string value + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText; and +&cdeman.XmTextSetString;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetTo.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetTo.sgm new file mode 100644 index 00000000..a92f7023 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtSetTo.sgm @@ -0,0 +1,93 @@ + + + + + + + + + + + +XmTextSetTopCharacter +library call + + +XmTextSetTopCharacter +A Text function that sets the position of the first character displayed + +XmTextSetTopCharacter + +Text functions +XmTextSetTopCharacter + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextSetTopCharacter + +Widget widget +XmTextPosition top_character + + + +DESCRIPTION +XmTextSetTopCharacter sets the position of the text at the top +of the Text widget. +If the XmNeditMode is XmMULTI_LINE_EDIT, the line of text +that contains top_character is displayed at the top of the widget +without the text shifting left or right. +If the edit mode is XmSINGLE_LINE_EDIT, the text moves horizontally +so that top_character is the first character displayed. + + + +widget + +Specifies the Text widget ID + + + + +top_character + +Specifies the position in the text to display at the top of the widget. +This is an integer number of characters from the beginning of the text +buffer. The first character position is 0 (zero). + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtShowP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtShowP.sgm new file mode 100644 index 00000000..a5ed6a46 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtShowP.sgm @@ -0,0 +1,92 @@ + + + + + + + + + + + +XmTextShowPosition +library call + + +XmTextShowPosition +A Text function that forces text at a given position to be displayed + +XmTextShowPosition + +Text functions +XmTextShowPosition + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Text.h> + +void XmTextShowPosition + +Widget widget +XmTextPosition position + + + +DESCRIPTION +XmTextShowPosition forces text at the specified position to be +displayed. If the XmNautoShowCursorPosition resource is True, the +application should also set the insert cursor to this position. + + + +widget + +Specifies the Text widget ID + + + + +position + +Specifies the character position to be displayed. This is an integer +number of characters from the beginning of the text buffer. The first +character position is 0 (zero). + + + + +If a navigator exists, this function uses the XmQTnavigator +trait to update the horizontal navigator's value. + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RELATED +&cdeman.XmText;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtXYToP.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtXYToP.sgm new file mode 100644 index 00000000..e09f8552 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/TxtXYToP.sgm @@ -0,0 +1,85 @@ + + + + + + + + + + +XmTextXYToPos +library call + + +XmTextXYToPos +A Text function that accesses the character position nearest an x and y position + +XmTextXYToPos + +Text functions +XmTextXYToPos + + + + +#include <Xm/Text.h> + +XmTextPosition XmTextXYToPos +Widget widget +Position x +Position y + + + +DESCRIPTION +XmTextXYToPos accesses the character position nearest to the +specified x and y position, relative to the upper left corner of the +Text widget. + +In the case of horizontal writing, the position is the origin of the character. +In the case of vertical writing, the position is the vertical origin of +the character. + + + +widget + +Specifies the Text widget ID + + + + +x + +Specifies the x position, relative to the upper left corner of the +widget + + + + +y + +Specifies the y position, relative to the upper left corner of the +widget + + + + +For a complete definition of Text and its associated resources, see +&cdeman.XmText;. + + + +RETURN +Returns the character position in the text nearest the x and y +position specified. This is an integer number of characters +from the beginning of the buffer. The first character position is 0 (zero). + + + +RELATED +&cdeman.XmText;. + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Uninstal.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Uninstal.sgm new file mode 100644 index 00000000..45d45752 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/Uninstal.sgm @@ -0,0 +1,79 @@ + + + + + + + + + + + +XmUninstallImage +library call + + +XmUninstallImage +A pixmap caching function that removes an image from the image cache + +XmUninstallImage + +pixmaps + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmUninstallImage + +XImage * image + + + +DESCRIPTION +XmUninstallImage removes an image from the image cache. + + + +image + +Points to the image structure given to the XmInstallImage() routine + + + + + + +RETURN +Returns True when successful; returns False if the image is +NULL, or if it cannot be found to be uninstalled. + + + +RELATED +&cdeman.XmInstallImage;, &cdeman.XmGetPixmap;, and &cdeman.XmDestroyPixmap;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/UpdateDi.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/UpdateDi.sgm new file mode 100644 index 00000000..2b388a2f --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/UpdateDi.sgm @@ -0,0 +1,78 @@ + + + + + + + + + + + +XmUpdateDisplay +library call + + +XmUpdateDisplay +A function that processes all pending exposure events immediately + +XmUpdateDisplay + + + + + + + + + + + + + + + + + + + + + + + + +void XmUpdateDisplay (widget) + Widget widget; + + + + + + +DESCRIPTION +XmUpdateDisplay provides the application with a mechanism for forcing all +pending exposure events to be removed from the input queue and processed immediately. +When a user selects a button within a menu pane, the menu panes are +unposted and then any activation callbacks registered by the application +are invoked. If one of the callbacks performs a time-consuming action, +the portion of the application window that was covered by the menu panes +will not have been redrawn; normal exposure processing does not occur until +all of the callbacks have been invoked. If the +application writer suspects that a callback +will take a long time, then the callback may choose to invoke +XmUpdateDisplay before starting its time-consuming operation. +This function is also useful any time a transient window, such as a dialog box, is unposted; +callbacks are invoked before normal exposure processing can occur. + + + +widget + +Specifies any widget or gadget. + + + + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreA.sgm new file mode 100644 index 00000000..7b8c57f1 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreA.sgm @@ -0,0 +1,235 @@ + + + + + + + + + + + +XmVaCreateSimpleCheckBox +library call + + +XmVaCreateSimpleCheckBox +A RowColumn widget convenience creation function + +XmVaCreateSimpleCheckBox + +creation functions +XmVaCreateSimpleCheckBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimpleCheckBox + +Widget parent +String name +XtCallbackProc callback + + + +DESCRIPTION +XmVaCreateSimpleCheckBox creates an instance of a RowColumn widget +of type XmWORK_AREA and returns the associated widget ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates a CheckBox and its ToggleButtonGadget children. +A CheckBox is similar to a RadioBox, except that more than one button +can be selected at a time. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +Buttons are named and created in the order in which they are specified +in the variable portion of the argument list. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +callback + +Specifies a callback procedure to be called when a button's value +changes. +This callback function is added to each button after creation as the +button's XmNvalueChangedCallback. +The callback function is called when a button's value changes, and the +button number is returned in the client_data field. + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +The following list describes the possible first arguments +in each group of varargs: + + + +XmVaCHECKBUTTON + +This is followed by four additional arguments. The set specifies one +button in the CheckBox and some of its resource values. +The following list describes the additional four arguments, in order. + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym. This is ignored in this release. + + + + +accelerator + +The accelerator, of type String. This is ignored in this release. + + + + +accelerator_text + +The accelerator text, of type XmString. This is ignored in this +release. + + + + + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +RowColumn widget. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the RowColumn widget. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in order: + + + +name + +The resource name, of type String + + + + +type + +The type of the resource value supplied, of type String + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal + + + + +size + +The size of the resource value in bytes, of type int + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. This +argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleRadioBox;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreB.sgm new file mode 100644 index 00000000..e7a6ee9b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreB.sgm @@ -0,0 +1,202 @@ + + + + + + + + + + + +XmVaCreateSimpleMenuBar +library call + + +XmVaCreateSimpleMenuBar +A RowColumn widget convenience creation function + +XmVaCreateSimpleMenuBar + +creation functions +XmVaCreateSimpleMenuBar + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimpleMenuBar + +Widget parent +String name + + + +DESCRIPTION +XmVaCreateSimpleMenuBar creates an instance of a RowColumn widget of +type XmMENU_BAR and returns the associated widget ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates a MenuBar and its CascadeButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +Buttons are named and created in the order in which they are specified +in the variable portion of the argument list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +Following are the possible first arguments in each group of varargs: + + + +XmVaCASCADEBUTTON + +This is followed by two additional arguments. The set specifies one +button in the MenuBar and some of its resource values. Following are +the additional two arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +RowColumn widget. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the RowColumn widget. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in order: + + + +name + +The resource name, of type String + + + + +type + +The type of the resource value supplied, of type String + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal + + + + +size + +The size of the resource value in bytes, of type int + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. This +argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateMenuBar;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleMenuBar;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreC.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreC.sgm new file mode 100644 index 00000000..b915b3a0 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreC.sgm @@ -0,0 +1,302 @@ + + + + + + + + + + + +XmVaCreateSimpleOptionMenu +library call + + +XmVaCreateSimpleOptionMenu +A RowColumn widget convenience creation function + +XmVaCreateSimpleOption\\%Menu + +creation functions +XmVaCreateSimpleOption\\%Menu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimpleOptionMenu + +Widget parent +String name +XmString option_label +KeySym option_mnemonic +int button_set +XtCallbackProc callback + + + +DESCRIPTION +XmVaCreateSimpleOptionMenu creates an instance of a RowColumn widget +of type XmMENU_OPTION and returns the associated widget ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates an OptionMenu and its Pulldown submenu containing +PushButtonGadget or CascadeButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an +integer from 0 (zero) to the number of separators in the menu minus 1. +Buttons and separators are named and created in the order in which they +are specified in the variable portion of the argument list. + + + +parent + +Specifies the parent widget ID + + + + +name + +Specifies the name of the created widget + + + + +option_label + +Specifies the label string to be used on the left side of the +OptionMenu. + + + + +option_mnemonic + +Specifies a keysym for a key that, when pressed by the user, posts +the associated Pulldown menu pane. + + + + +button_set + +Specifies which PushButtonGadget is initially set. +The value is the integer n that corresponds to the nth +PushButtonGadget specified in the variable portion of the argument list. +Only a PushButtonGadget can be set, and only PushButtonGadgets are +counted in determining the integer n. +The first PushButtonGadget is number 0 (zero). + + + + +callback + +Specifies a callback procedure to be called when a button is activated. +This callback function is added to each button after creation as the +button's XmNactivateCallback. +The callback function is called when a button is activated, and the +button number is returned in the client_data field. + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +Following are the possible first arguments in each group of varargs: + + + +XmVaPUSHBUTTON + +This is followed by four additional arguments. The set specifies one +button in the OptionMenu's Pulldown submenu and some of its resource +values. The button created is a PushButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + +XmVaSEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the OptionMenu's Pulldown submenu. + + + + +XmVaDOUBLE_SEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the OptionMenu's Pulldown submenu. The separator type is +XmDOUBLE_LINE. + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +Pulldown submenu. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the Pulldown submenu. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in order: + + + +name + +The resource name, of type String + + + + +type + +The type of the resource value supplied, of type String + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal + + + + +size + +The size of the resource value in bytes, of type int + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. +This argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +The user can specify resources in a resource file for the automatically +created widgets and gadgets of an OptionMenu. The following list +identifies the names of these widgets (or gadgets) and the associated +OptionMenu areas: + + + +Option Menu Label Gadget + +OptionLabel + + + + +Option Menu Cascade Button + +OptionButton + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateOptionMenu;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleOptionMenu;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreD.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreD.sgm new file mode 100644 index 00000000..1175232b --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreD.sgm @@ -0,0 +1,385 @@ + + + + + + + + + + + +XmVaCreateSimplePopupMenu +library call + + +XmVaCreateSimplePopupMenu +A RowColumn widget convenience creation function + +XmVaCreateSimplePopup\\%Menu + +creation functions +XmVaCreateSimplePopup\\%Menu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimplePopupMenu + +Widget parent +String name +XtCallbackProc callback + + + +DESCRIPTION +XmVaCreateSimplePopupMenu creates an instance of a RowColumn widget +of type XmMENU_POPUP and returns the associated widget ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates a Popup menu pane and its button children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an +integer from 0 (zero) to the number of separators in the menu minus 1. +The name of each title is label_n, where n is an +integer from 0 (zero) to the number of titles in the menu minus 1. +Buttons, separators, and titles are named and created in the order in +which they are specified in the variable portion of the argument list. + + + +parent + +Specifies the widget ID of the parent of the MenuShell + + + + +name + +Specifies the name of the created widget + + + + +callback + +Specifies a callback procedure to be called when a button is activated +or when its value changes. +This callback function is added to each button after creation. +For a CascadeButtonGadget or a PushButtonGadget, the callback is added +as the button's XmNactivateCallback, and it is called when the +button is activated. +For a ToggleButtonGadget, the callback is added as the button's +XmNvalueChangedCallback, and it is called when the button's value +changes. +The button number is returned in the client_data field. + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +The following list describes the possible first arguments in +each group of varargs. + + + +XmVaCASCADEBUTTON + +This is followed by two additional arguments. The set specifies one +button in the PopupMenu and some of its resource +values. The button created is a CascadeButtonGadget. Following are the +additional two arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + + + + + +XmVaPUSHBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PopupMenu and some of its resource +values. The button created is a PushButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + +XmVaRADIOBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PopupMenu and some of its resource +values. The button created is a ToggleButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + +XmVaCHECKBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PopupMenu and some of its resource +values. The button created is a ToggleButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + + + +XmVaTITLE + +This is followed by one additional argument. The pair specifies a +title LabelGadget in the PopupMenu. Following is the +additional argument: + + + +title + +The title string, of type XmString + + + + + + + + +XmVaSEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the PopupMenu. + + + + +XmVaDOUBLE_SEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the PopupMenu. The separator type is +XmDOUBLE_LINE. + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +RowColumn widget. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the RowColumn widget. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in order: + + + +name + +The resource name, of type String + + + + +type + +The type of the resource value supplied, of type String + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal + + + + +size + +The size of the resource value in bytes, of type int + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. This +argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreatePopupMenu;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimplePopupMenu;, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreE.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreE.sgm new file mode 100644 index 00000000..25270760 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreE.sgm @@ -0,0 +1,408 @@ + + + + + + + + + + + +XmVaCreateSimplePulldownMenu +library call + + +XmVaCreateSimplePulldownMenu +A RowColumn widget convenience creation function + +XmVaCreateSimplePulldown\\%Menu + +creation functions +XmVaCreateSimplePulldown\\%Menu + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimplePulldownMenu + +Widget parent +String name +int post_from_button +XtCallbackProc callback + + + +DESCRIPTION +XmVaCreateSimplePulldownMenu creates an instance of a RowColumn +widget of type XmMENU_PULLDOWN and returns the associated widget +ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates a Pulldown menu pane and its button children. +The name of each button is button_n, where n is an integer +from 0 to the number of buttons in the menu minus 1. +The name of each separator is separator_n, where n is an +integer from 0 to the number of separators in the menu minus 1. +The name of each title is label_n, where n is an +integer from 0 (zero) +to the number of titles in the menu minus 1. +Buttons, separators, and titles are named and created in the order in +which they are specified in the variable portion of the argument list. + +This routine also attaches the PulldownMenu to a CascadeButton or +CascadeButtonGadget in the parent. +The PulldownMenu is then posted from this button. + + + +parent + +Specifies the widget ID of the parent of the MenuShell. + + + + +name + +Specifies the name of the created widget. + + + + +post_from_button + +Specifies the CascadeButton or CascadeButtonGadget in the parent to +which the Pulldown menu pane is attached. +The value is the integer n that corresponds to the nth +CascadeButton or CascadeButtonGadget specified for the parent of the +Pulldown menu pane. +A Pulldown menu pane can be attached only to a CascadeButton or +CascadeButtonGadget, and only CascadeButtons and CascadeButtonGadgets +are counted in determining the integer n. +The first CascadeButton or CascadeButtonGadget is number 0 (zero). + + + + +callback + +Specifies a callback procedure to be called when a button is activated +or when its value changes. +This callback function is added to each button after creation. +For a CascadeButtonGadget or a PushButtonGadget, the callback is added +as the button's XmNactivateCallback, and it is called when the +button is activated. +For a ToggleButtonGadget, the callback is added as the button's +XmNvalueChangedCallback, and it is called when the button's value +changes. +The button number is returned in the client_data field. + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +Following are the possible first arguments in each group of varargs: + + + +XmVaCASCADEBUTTON + +This is followed by two additional arguments. The set specifies one +button in the PulldownMenu and some of its resource +values. The button created is a CascadeButtonGadget. Following are the +additional two arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + + + + + +XmVaPUSHBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PulldownMenu and some of its resource +values. The button created is a PushButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + +XmVaRADIOBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PulldownMenu and some of its resource +values. The button created is a ToggleButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + + + +XmVaCHECKBUTTON + +This is followed by four additional arguments. The set specifies one +button in the PulldownMenu and some of its resource +values. The button created is a ToggleButtonGadget. Following are the +additional four arguments, in order: + + + +label + +The label string, of type XmString. + + + + +mnemonic + +The mnemonic, of type KeySym + + + + +accelerator + +The accelerator, of type String + + + + +accelerator_text + +The accelerator text, of type XmString + + + + + + + + +XmVaTITLE + +This is followed by one additional argument. The pair specifies a +title LabelGadget in the PulldownMenu. Following is the +additional argument: + + + +title + +The title string, of type XmString + + + + + + + + +XmVaSEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the PulldownMenu. + + + + +XmVaDOUBLE_SEPARATOR + +This is followed by no additional arguments. It specifies one separator +in the PulldownMenu. The separator type is +XmDOUBLE_LINE. + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +RowColumn widget. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the RowColumn widget. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in order: + + + +name + +The resource name, of type String. + + + + +type + +The type of the resource value supplied, of type String. + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal. + + + + +size + +The size of the resource value in bytes, of type int. + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. This +argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreatePulldownMenu;, +&cdeman.XmCreateRowColumn;, +XmCreateSimplePulldownMenu, and +&cdeman.XmRowColumn;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreF.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreF.sgm new file mode 100644 index 00000000..34608ce6 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/VaCreF.sgm @@ -0,0 +1,239 @@ + + + + + + + + + + + +XmVaCreateSimpleRadioBox +library call + + +XmVaCreateSimpleRadioBox +A RowColumn widget convenience creation function + +XmVaCreateSimpleRadioBox + +creation functions +XmVaCreateSimpleRadioBox + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/RowColumn.h> + +Widget XmVaCreateSimpleRadioBox + +Widget parent +String name +int button_set +XtCallbackProc callback + + + +DESCRIPTION +XmVaCreateSimpleRadioBox creates an instance of a RowColumn widget +of type XmWORK_AREA and returns the associated widget ID. +This routine uses the ANSI C variable-length argument list (varargs) +calling convention. + +This routine creates a RadioBox and its ToggleButtonGadget children. +The name of each button is button_n, where n is an integer +from 0 (zero) to the number of buttons in the menu minus 1. + + + +parent + +Specifies the parent widget ID. + + + + +name + +Specifies the name of the created widget. + + + + +button_set + +Specifies which button is initially set. +The value is the integer n in the button name button_n. + + + + +callback + +Specifies a callback procedure to be called when a button's value +changes. +This callback function is added to each button after creation as the +button's XmNvalueChangedCallback. +The callback function is called when a button's value changes, and the +button number is returned in the client_data field. + + + + +The variable portion of the argument list consists of groups of +arguments. +The first argument in each group is a constant or a string and +determines which arguments follow in that group. +The last argument in the list must be NULL. +Following are the possible first arguments in each group of varargs: + + + +XmVaRADIOBUTTON + +This is followed by four additional arguments. The set specifies one +button in the RadioBox and some of its resource values. Following are +the additional four arguments, in order: + + + +label + +The label string, of type XmString. + + + + +mnemonic + +The mnemonic, of type KeySym. This is ignored in this release. + + + + +accelerator + +The accelerator, of type String. This is ignored in this release. + + + + +accelerator_text + +The accelerator text, of type XmString. This is ignored in this +release. + + + + + + + + +resource_name + +This is followed by one additional argument, the value of the resource, +of type XtArgVal. The pair specifies a resource and its value for the +RowColumn widget. + + + + +XtVaTypedArg + +This is followed by four additional arguments. The set specifies a +resource and its value for the RowColumn widget. A resource type +conversion is performed if necessary. Following are the additional four +arguments, in this order: + + + +name + +The resource name, of type String + + + + +type + +The type of the resource value supplied, of type String + + + + +value + +The resource value (or a pointer to the resource value, depending on the +type and size of the value), of type XtArgVal + + + + +size + +The size of the resource value in bytes, of type int + + + + + + + + +XtVaNestedList + +This is followed by one additional argument of type XtVarArgsList. This +argument is a nested list of varargs returned by +XtVaCreateArgsList. + + + + +For more information on variable-length argument lists, see the X +Toolkit Intrinsics documentation. + +A number of resources exist specifically for use with this and +other simple menu creation routines. +For a complete definition of RowColumn and its associated resources, see +&cdeman.XmRowColumn;. + + + +RETURN +Returns the RowColumn widget ID. + + + +RELATED +&cdeman.XmCreateRadioBox;, +&cdeman.XmCreateRowColumn;, +&cdeman.XmCreateSimpleCheckBox;, +&cdeman.XmCreateSimpleRadioBox;, +&cdeman.XmRowColumn;, and +&cdeman.XmVaCreateSimpleCheckBox;, + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGA.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGA.sgm new file mode 100644 index 00000000..56ea6103 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGA.sgm @@ -0,0 +1,105 @@ + + + + + + + + + + + +XmWidgetGetBaselines +library call + + +XmWidgetGetBaselines +Retrieves baseline information for +a widget + +XmWidgetGetBaselines + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmWidgetGetBaselines + +Widget widget +Dimension **baselines +int *line_count + + + +DESCRIPTION +XmWidgetGetBaselines returns an array that +contains one or more baseline values associated with the +specified widget. The baseline of any given line of text +is a vertical offset in pixels from the origin of the +widget's bounding box to the given baseline. + + + +widget + +Specifies the ID of the widget for which baseline values +are requested + + + + +baselines + +Returns an array that contains the value of each +baseline of text in the widget. +The function allocates space to hold the returned array. +The application is responsible for managing the allocated space. +The application can recover this allocated space by calling XtFree. + + + + +line_count + +Returns the number of lines in the widget + + + + + + +RETURN +Returns a Boolean value that indicates whether the +widget contains a baseline. If the value is True, the function returns +a value for each baseline of text. If it is False, the function +was unable to return a baseline value. + + + +RELATED +&cdeman.XmWidgetGetDisplayRect;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGB.sgm b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGB.sgm new file mode 100644 index 00000000..bc5f1204 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR3X_Xm/WidgetGB.sgm @@ -0,0 +1,102 @@ + + + + + + + + + + + +XmWidgetGetDisplayRect +library call + + +XmWidgetGetDisplayRect +Retrieves display rectangle +information for a widget + +XmWidgetGetDisplayRect + + + + + + + + + + + + + + + + + + + + + + + + +#include <Xm/Xm.h> + +Boolean XmWidgetGetDisplayRect + +Widget widget +XRectangle *displayrect + + + +DESCRIPTION +XmWidgetGetDisplayRect returns the width, height and +the x and y-coordinates of the upper left corner of the display +rectangle of the specified widget. The display rectangle +is the smallest rectangle that encloses either a string +or a pixmap. + +If the widget contains a string, the return values specify +the x and y-coordinates of the upper left corner of +the display rectangle relative to the origin of the widget +and the width and height in pixels. + +In the case of a pixmap, the return values +specify the x and y-coordinates of the upper left corner of +the pixmap relative to the origin, and the width +and height of the pixmap in pixels. + + + +widget + +Specifies the widget ID + + + + +displayrect + +Specifies a pointer to an XRectangle structure in which the +x and y-coordinates, width and height of the display rectangle +are returned + + + + + + +RETURN +Returns True if the specified widget has an associated +display rectangle; otherwise, returns False. + + + +RELATED +&cdeman.XmWidgetGetBaselines;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR4X/mwmrc.sgm b/cde/imports/motif/doc/C/guides/man/PR4X/mwmrc.sgm new file mode 100644 index 00000000..94fd5369 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR4X/mwmrc.sgm @@ -0,0 +1,914 @@ + + + + + + + + + +mwmrcspecial file + +mwmrcthe +mwm Window Manager Resource Description File + + + + + + + + + + + + +DESCRIPTION +The mwmrc window manager is a supplementary resource +file that controls much of the behavior of the CDE window manager mwm. It contains descriptions of resources that cannot easily be +written using standard X Window System, Version 11 resource syntax. The resource +description file contains entries that are referred to by X resources in +defaults files (for example, /usr/mwm/app-defaults/$LANG/mwm) +or in the RESOURCE_MANAGER property on the +root window. For example, the resource description file enables you to specify +different types of window menus; however, an X resource is used to specify +which of these window menus the mwm should use for a particular +window. The specifications of the resource description file supported by the +mwm workspace manager are a strict superset of the specifications supported +by the OSF Motif Window Manager (mwm 1.2.4). In other words, +the system.mwmrc or $HOME/.mwmrc file +that you've used for mwm is easily made usable by mwm. + + +Location +The workspace manager searches for one of the following resource description +files, where $LANG is the value of the language environment +on a per-user basis: +$HOME/$LANG/.mwmrc +$HOME/.mwmrc +/usr/lib/X11/$LANG/system.mwmrc +/usr/lib/X11/system.mwmrc +The first file found is the first used. If no file is found, a +set of built-in specifications is used. A particular resource description +file can be selected using the configFile +resource. The following shows how a different resource description file can +be specified from the command line: + +/usr/mwm/bin/mwm -xrm "mwm*configFile: mymwmrc" + + + +Resource Types +The following types of resources can be described in the mwm resource +description file: + +Buttons + +Workspace manager functions can be bound (associated) with button events. + + + +Keys + +Workspace manager functions can be bound (associated) with key press +events. + + +Menus + +Menu panes can be used for the window menu and other menus posted with +key bindings and button bindings. + + + + + + +MWM RESOURCE DESCRIPTION FILE SYNTAX +The mwm resource description file is a standard +text file that contains items of information separated by blanks, tabs, and +new lines characters. Blank lines are ignored. Items or characters can be +quoted to avoid special interpretation (for example, the comment character +can be quoted to prevent it from being interpreted as the comment character). +A quoted item can be contained in double quotes (" "). +Single characters can be quoted by preceding them by the back-slash character +(\), except for workspace names, which may contain no back-slash +characters. If a line ends with a back-slash, the next line is considered +a continuation of that line. All text from an unquoted # +to the end of the line is regarded as a comment and is not interpreted as +part of a resource description. If ! is the first character +in a line, the line is regarded as a comment. + +Workspace Manager Functions +Workspace manager functions can be accessed with button and key bindings, +and with workspace manager menus. Functions are indicated as part of the specifications +for button and key binding sets, and menu panes. The function specification +has the following syntax: + +function = function_name [function_args] +function_name = workspace manager function +function_args = {quoted_item | unquoted_item} + +The following functions are supported. If a function is specified that +isn't one of the supported functions then it is interpreted by mwm as f.nop. + +f.beep + +This function causes a beep. + + +f.circle_down [ icon | window] + +This function causes the window or icon that is on the top of the window +stack to be put on the bottom of the window stack (so that it is no longer +obscuring any other window or icon). This function affects only those windows +and icons that are obscuring other windows and icons, or that are obscured +by other windows and icons. Secondary windows (that is, transient windows) +are restacked with their associated primary window. Secondary windows always +stay on top of the associated primary window and there can be no other primary +windows between the secondary windows and their primary window. If an +icon function argument is specified, then the function +applies only to icons. If a window function +argument is specified then the function applies only to windows. + + +f.circle_up [ icon | window] + +This function raises the window or icon on the bottom of the window +stack (so that it is not obscured by any other windows). This function affects +only those windows and icons that are obscuring other windows and icons, or +that are obscured by other windows and icons. Secondary windows (that is, +transient windows) are restacked with their associated primary window. If +an icon function argument is specified then +the function applies only to icons. If an window +function argument is specified then the function applies only to windows. + + + +f.exec command +(or ! command) + +This function causes command to be +executed (using the value of the $MWMSHELL or $SHELL environment variable if set; otherwise, /usr/bin/sh ). The ! notation can be used in place of the f.exec function name. + + +f.focus_color + +This function sets the colormap focus to a client window. If this function +is done in a root context, then the default colormap (setup by the X Window +System for the screen where mwm is running) is installed +and there is no specific client window colormap focus. This function is treated +as f.nop if colormapFocusPolicy +is not explicit. + + +f.focus_key + +This function sets the keyboard input focus to a client window or icon. +This function is treated as f.nop if keyboardFocusPolicy is not explicit or the function is executed in a root context. + + + +f.kill + +This function is used to close application windows. The actual processing +that occurs depends on the protocols that the application observes. The application +lists the protocols it observes in the WM_PROTOCOLS property +on its top level window. If the application observes the WM_DELETE_WINDOW protocol, it is sent a message that requests the window be deleted. +If the application observes both WM_DELETE_WINDOW and WM_SAVE_YOURSELF, it is sent one message requesting the window +be deleted and another message advising it to save its state. If the application +observes only the WM_SAVE_YOURSELFprotocol , it is sent a message advising it to save its state. After a +delay (specified by the resource quitTimeout), the application's +connection to the X server is terminated. If the application observes neither +of these protocols, its connection to the X server is terminated. + + +f.lower [− client | within | freeFamily] + +This function lowers a primary window to the bottom of the global window +stack (where it obscures no other window) and lowers the secondary window +(transient window or dialog box) within the client family. The arguments to +this function are mutually exclusive. The client +argument indicates the name or class of a client to lower. The name or class +of a client appears in the WM_CLASS property on the +client's top-level window. If the client +argument is not specified, the context that the function was invoked in indicates +the window or icon to lower. Specifying within +lowers the secondary window within the family (staying above the parent) but +does not lower the client family in the global window stack. Specifying freeFamily lowers the window to the bottom of the global windows +stack from its local family stack. + + +f.maximize + +This function causes a client window to be displayed with its maximum +size. Refer to the maximumClientSize, maximumMaximumSize, and limitResize resources in &cdeman.mwm;. + + +f.menu menu_name + +This function associates a cascading (pull-right) menu with a menu +pane entry or a menu with a button or key binding. The menu_name function argument identifies the menu to be used. + + +f.minimize + +This function causes a client window to be minimized (iconified). When +a window is minimized with no icon box in use, and if the lowerOnIconify resource has the value True (the default), the icon is placed +on the bottom of the window stack (such that it obscures no other window). +If an icon box is used, then the client's icon changes to its iconified form +inside the icon box. Secondary windows (that is, transient windows) are minimized +with their associated primary window. There is only one icon for a primary +window and all its secondary windows. + + +f.move + +This function initiates an interactive move of a client window. + + +f.next_cmap + +This function installs the next colormap in the list of colormaps for +the window with the colormap focus. + + +f.next_key [ icon | window | transient] + +This function sets the keyboard input focus to the next window/icon +in the set of windows/icons managed by the workspace manager (the ordering +of this set is based on the stacking of windows on the screen). This function +is treated as f.nop if keyboardFocusPolicy +is not explicit. The keyboard input focus is only moved to windows that do +not have an associated secondary window that is application modal. If the +transient argument is specified, then transient (secondary) +windows are traversed (otherwise, if only window +is specified, traversal is done only to the last focused window in a transient +group). If an icon function argument is specified, +then the function applies only to icons. If a window function argument is specified, then the function applies only to +windows. + + +f.nop + +This function does nothing. + + +f.normalize + +This function causes a client window to be displayed with its normal +size. Secondary windows (that is, transient windows) are placed in their normal +state along with their associated primary window. + + +f.normalize_and_raise + +This function causes a client window to be displayed with its normal +size and raised to the top of the window stack. Secondary windows (that is, +transient windows) are placed in their normal state along with their associated +primary window. + + +f.pack_icons + +This function is used to relayout icons (based on the layout policy +being used) on the root window or in the icon box. In general this causes +icons to be "packed" into the icon grid. + + +f.pass_keys + +This function is used to enable/disable (toggle) processing of key bindings +for workspace manager functions. When it disables key binding processing all +keys are passed on to the window with the keyboard input focus and no workspace +manager functions are invoked. If the f.pass_keys function +is invoked with a key binding to disable key binding processing the same key +binding can be used to enable key binding processing. + + +f.post_wmenu + +This function is used to post the window menu. If a key is used to post +the window menu and a window menu button is present, the window menu is automatically +placed with its top-left corner at the bottom-left corner of the window menu +button for the client window. If no window menu button is present, the window +menu is placed at the top-left corner of the client window. + + +f.prev_cmap + +This function installs the previous colormap in the list of colormaps +for the window with the colormap focus. + + +f.prev_key [ icon | window | transient] + +This function sets the keyboard input focus to the previous window/icon +in the set of windows/icons managed by the workspace manager (the ordering +of this set is based on the stacking of windows on the screen). This function +is treated as f.nop if keyboardFocusPolicy is not explicit. The keyboard input focus is only moved to windows +that do not have an associated secondary window that is application modal. +If the transient argument is specified, then +transient (secondary) windows are traversed (otherwise, if only window is specified, traversal is done only to the last focused window +in a transient group). If an icon function +argument is specified then the function applies only to icons. If an +window function argument is specified then the function +applies only to windows. + + +f.quit_mwm + +This function terminates mwm (but NOT the X window system). + + +f.raise [−client | within +| freeFamily] + +This function raises a primary window to the top of the global window +stack (where it is obscured by no other window) and raises the secondary window +(transient window or dialog box) within the client family. The arguments to +this function are mutually exclusive. The client +argument indicates the name or class of a client to lower. If the client +is not specified, the context that the function +was invoked in indicates the window or icon to lower. Specifying within raises the secondary window within the family but does not +raise the client family in the global window stack. Specifying freeFamily raises the window to the top of its local family stack +and raises the family to the top of the global window stack. + + +f.raise_lower [ within | freeFamily] + +This function raises a primary window to the top of the global window +stack if it is partially obscured by another window; otherwise, it lowers +the window to the bottom of the window stack. The arguments to this function +are mutually exclusive. Specifying within +raises a secondary window within the family (staying above the parent window), +if it is partially obscured by another window in the application's family; +otherwise, it lowers the window to the bottom of the family stack. It has +no effect on the global window stacking order. Specifying freeFamily raises the window to the top of its local family stack, if obscured +by another window, and raises the family to the top of the global window +stack; otherwise, it lowers the window to the bottom of its local family stack +and lowers the family to the bottom of the global window stack. + + +f.refresh + +This function causes all windows to be redrawn. + + +f.refresh_win + +This function causes a client window to be redrawn. + + +f.resize + +This function initiates an interactive resize of a client window. + + +f.restore + +This function restores the previous state of an icon's associated window. +If a maximized window is iconified, then f.restore restores +it to its maximized state. If a normal window is iconified, then f.restore restores it to its normalized state. + + +f.restore_and_raise + +This function restores the previous state of an icon's associated window +and raises the window to the top of the window stack. If a maximized window +is iconified, then f.restore_and_raise restores it to +its maximized state and raises it to the top of the window stack. If a normal +window is iconified, then f.restore_and_raise restores +it to its normalized state and raises it to the top of the window stack. + + +2f.restart + +This function causes mwm to be restarted (effectively terminated and +re-executed). Restart is necessary for mwm to incorporate +changes in both the mwmrc file and X resources. + + +f.screen [ next | prev | back | screen_number] + +This function causes the pointer to be warp to a specific screen number +or to the next, previous, or last visited (back) +screen. The arguments to this function are mutually exclusive. The +screen_number argument indicates the screen number +that the pointer is to be warped. Screens are numbered starting from screen +0. Specifying next cause the pointer to warp +to the next managed screen (skipping over any unmanaged screens). Specifying +prev cause the pointer to warp to the previous managed +screen (skipping over any unmanaged screens). Specifying back cause the pointer to warp to the last visited screen. + + +f.send_msg message_number + +This function sends an XClientMessageEvent of type _MOTIF_WM_MESSAGES with +message_type set to message_number. +The client message is sent only if message_number +is included in the client's _MOTIF_WM_MESSAGES +property. A menu item label is grayed out if the menu item is used to do f.send_msg of a message that is not included in the client's _MOTIF_WM_MESSAGES property. + + +f.separator + +This function causes a menu separator to be put in the menu pane at +the specified location (the label is ignored). + + +f.set_behavior + +This function causes the workspace manager to restart with the default +behavior (if a custom behavior is configured) or a custom behavior (if a +default behavior is configured). By default this is bound to Shift Ctrl Alt <Key>!. + + +f.title + +This function inserts a title in the menu pane at the specified location. + + + +f.version + +This function causes the workspace manager to display its release version +in a dialog box. + + + + + +Function Constraints +Each function may be constrained as to which resource types can specify +the function (for example, menu pane) and also what context the function +can be used in (for example, the function is done to the selected client window). +Function contexts are: + +root + +No client window or icon has been selected as an object for the function. + + + +window + +A client window has been selected as an object for the function. This +includes the window's title bar and frame. Some functions are applied only +when the window is in its normalized state (for example, f.maximize) or its maximized state (for example, f.normalize). + + + +icon + +An icon has been selected as an object for the function. + + + +If a function is specified in a type of resource where it is not supported +or is invoked in a context that does not apply then the function is treated +as f.nop. The following table indicates the resource +types and function contexts in which workspace manager functions apply. + + + + + + + + +Function +Contexts +Resources + +f.beep +root,icon,window +button,key,menu + +f.circle_down +root,icon,window +button,key,menu + +f.circle_up +root,icon,window +button,key,menu + +f.exec +root,icon,window +button,key,menu + +f.focus_color +root,icon,window +button,key,menu + +f.focus_key +root,icon,window +button,key,menu + +f.kill +icon,window +button,key,menu + +f.lower +root,icon,window +button,key,menu + +f.maximize +icon,window(normal) +button,key,menu + +f.menu +root,icon,window +button,key,menu + +f.minimize +window +button,key,menu + +f.move +icon,window +button,key,menu + +f.next_cmap +root,icon,window +button,key,menu + +f.next_key +root,icon,window +button,key,menu + +f.nop +root,icon,window +button,key,menu + +f.normalize +icon,window(maximized) +button,key,menu + +f.normalize_and_raise +icon,window +button,key,menu + +f.pack_icons +root,icon,window +button,key,menu + +f.pass_keys +root,icon,window +button,key,menu + +f.post_wmenu +root,icon,window +button,key + +f.prev_cmap +root,icon,window +button,key,menu + +f.prev_key +root,icon,window +button,key,menu + +f.quit_mwm +root +button,key,menu (root only) + +f.raise +root,icon,window +button,key,menu + +f.raise_lower +icon,window +button,key,menu + +f.refresh +root,icon,window +button,key,menu + +f.refresh_win +window +button,key,menu + +f.resize +window +button,key,menu + +f.restart +root +button,key,menu (root only) + +f.restore +icon,window +button,key,menu + +f.restore_and_raise +icon,window +button,key,menu + +f.screen +root,icon,window +button,key,menu + +f.send_msg +icon,window +button,key,menu + +f.separator +root,icon,window +menu + +f.set_behavior +root,icon,window +button,key,menu + +f.title +root,icon,window +menu + +f.version +root,icon,window +button,key,menu + + + + + +WORKSPACE MANAGER EVENT SPECIFICATION +Events are indicated as part of the specifications for button and key +binding sets, and menu panes. Button events have the following syntax: + +button =~[modifier_list ]<button_event_name > +modifier_list =~modifier_name { modifier_name} + +The following table indicates the values that can be used for modifier_name. Note that [Alt] and [Meta] can be used interchangably +on some hardware. + + + + + + +Modifier +Description + +Ctrl +Control Key + +Shift +Shift Key + +Alt +Alt Key + +Meta +Meta Key + +Mod1 +Modifier1 + +Mod2 +Modifier2 + +Mod3 +Modifier3 + +Mod4 +Modifier4 + +Mod5 +Modifier5 + +Locking modifiers are ignored when processing button and key bindings. +The following table lists keys that are interpreted as locking modifiers. +The X server may map some of these symbols to the Mod1 - Mod5 modifier keys. +These keys may or may not be available on your hardware: Key Symbol Caps Lock +Shift Lock Kana Lock Num Lock Scroll Lock The following table indicates the +values that can be used for button_event_name. + + + + + + +Button +Description + +Btn1Down +Button 1 Press + +Btn1Up +Button 1 Release + +Btn1Click +Button 1 Press and Release + +Btn1Click2 +Button 1 Double Click + +Btn2Down +Button 2 Press + +Btn2Up +Button 2 Release + +Btn2Click +Button 2 Press and Release + +Btn2Click2 +Button 2 Double Click + +Btn3Down +Button 3 Press + +Btn3Up +Button 3 Release + +Btn3Click +Button 3 Press and Release + +Btn3Click2 +Button 3 Double Click + +Btn4Down +Button 4 Press + +Btn4Up +Button 4 Release + +Btn4Click +Button 4 Press and Release + +Btn4Click2 +Button 4 Double Click + +Btn5Down +Button 5 Press + +Btn5Up +Button 5 Release + +Btn5Click +Button 5 Press and Release + +Btn5Click2 +Button 5 Double Click + +Key events that are used by the workspace manager for menu mnemonics +and for binding to workspace manager functions are single key presses; key +releases are ignored. Key events have the following syntax: + +key =~[modifier_list] Keykey_name +modifier_list =~modifier_name { modifier_name} + +All modifiers specified are interpreted as being exclusive (this means +that only the specified modifiers can be present when the key event occurs). +Modifiers for keys are the same as those that apply to buttons. The key_name is an X11 keysym name. Keysym names can be found in the +keysymdef.h file (remove the XK_ +prefix). + + +BUTTON BINDINGS +The buttonBindings resource value is the name of +a set of button bindings that are used to configure workspace manager behavior. +A workspace manager function can be done when a button press occurs with +the pointer over a framed client window, an icon or the root window. The +context for indicating where the button press applies is also the context +for invoking the workspace manager function when the button press is done +(significant for functions that are context sensitive). The button binding +syntax is + +Buttons bindings_set_name +{ + button context function + button context function + ... + button context function +} + +The syntax for the context specification is: context = object[| context] object = root | icon | window | title | frame | border | app The context specification indicates where the pointer must be +for the button binding to be effective. For example, a context of +window indicates that the pointer must be over a +client window or window management frame for the button binding to be effective. +The frame context is for the window management +frame around a client window (including the border and titlebar), the +border context is for the border part of the window +management frame (not including the titlebar), the title context is for the title area of the window management frame, +and the app context is for the application +window (not including the window management frame). If an f.nop function is specified for a button binding, the button binding +is not done. + + +KEY BINDINGS +The keyBindings resource value is the name of a set +of key bindings that are used to configure workspace manager behavior. A +window manager function can be done when a particular key is pressed. The +context in which the key binding applies is indicated in the key binding specification. +The valid contexts are the same as those that apply to button bindings. The +key binding syntax is: + +Keys bindings_set_name +{ + key context function + key context function + ... + key context function +} + +If an f.nop function is specified for a key binding, +the key binding is not done. If an f.post_wmenu or f.menu function is bound to a key, mwm automatically +uses the same key for removing the menu from the screen after it has been +popped up. The context specification syntax is the same +as for button bindings with one addition. The context ifkey +may be specified for binding keys that may not be available on all displays. +If the key is not available and if ifkey is in the context, +then reporting of the error message to the error log is suppressed. This feature +is useful for networked, heterogeneous environments. For key bindings, the +frame, title, +border, and app +contexts are equivalent to the window context. +The context for a key event is the window or icon that has the keyboard input +focus (root if no window or icon has the +keyboard input focus). + + +MENU PANES +Menus can be popped up using the f.post_wmenu and f.menu workspace manager functions. The context for workspace manager +functions that are done from a menu is root, +icon or window depending +on how the menu was popped up. In the case of the window menu or menus popped up with a key binding, the location of +the keyboard input focus indicates the context. For menus popped up using +a button binding, the context of the button binding is the context of the +menu. The menu pane specification syntax is: + +Menu menu_name +{ + label [mnemonic] [accelerator ] function + label [mnemonic] [accelerator ] function + ... + label [mnemonic] [accelerator ] function +} + +Each line in the Menu specification identifies +the label for a menu item and the function to be done if the menu item is +selected. Optionally a menu button mnemonic and a menu button keyboard accelerator +may be specified. Mnemonics are functional only when the menu is posted and +keyboard traversal applies. The label may be a string or +a bitmap file. The label specification has the following syntax: + +label = text | bitmap_file +bitmap_file = @file_name +text = quoted_item | unquoted_item + +The string encoding for labels must be compatible with the menu font +that is used. Labels are greyed out for menu items that do the f.nop function or an invalid function or a function that doesn't +apply in the current context. A mnemonic specification +has the following syntax: + +mnemonic = _ character + +The first matching character in the label is underlined. +If there is no matching character in the label, no mnemonic +is registered with the workspace manager for that label. Although the character must exactly match a character in the label, the mnemonic +does not execute if any modifier (such as Shift) is pressed with the character +key. The accelerator specification is a key event specification +with the same syntax as is used for key bindings to workspace manager functions. + + + +INCLUDING FILES +You may include other files into your mwmrc file by using the +include construct. For example, + +INCLUDE +{ + /usr/local/shared/mwm.menus + /home/kmt/personal/my.bindings +} + +causes the files named to be read in and interpreted in order as an +additional part of the mwmrc file. Include is a top-level +construct. It cannot be nested inside another construct. + + +WARNINGS +Errors that occur during the processing of the resource description +file are recorded in: $HOME/.mwm/errorlog. Be sure to +check this file if the appearance or behavior of mwm +is not what you expect. + + +FILES +$HOME/$LANG/.mwmrc +$HOME/.mwmrc +/usr/lib/X11/$LANG/system.mwmrc +/usr/lib/X11/system.mwmrc +$HOME/.mwm/errorlog + + +RELATED INFORMATION +&cdeman.mwm;, mwm(1X), +X(1). + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR5X/Traits.sgm b/cde/imports/motif/doc/C/guides/man/PR5X/Traits.sgm new file mode 100644 index 00000000..59a794aa --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR5X/Traits.sgm @@ -0,0 +1,828 @@ + + + + + + + + + + + +Traits +file formats + + +Traits +Lists the traits used by the Motif Toolkit. + +Traits + + + + + + + + + + +DESCRIPTION +A trait is a characteristic of a widget. A widget holding +a particular trait is announcing a particular ability to +other widgets. +The following table summarizes the standard Motif traits. + + + + + + + + +Purpose of Each Trait + + +Trait Name +A Widget Holding This Trait Can Do The Following: + + +XmQTaccessTextual +Display one primary text parcel. + + +XmQTactivatable +Become a command button in a dialog box. + + +XmQTcareParentVisual +Borrow its parent's visual information. + + +XmQTcontainer +Manage container item children. + + +XmQTcontainerItem +Become a child of a container widget. + + +XmQTdialogShellSavvy +Become a child of a DialogShell. + + +XmQTjoinSide +Attach itself to one side of a suitable parent. + + +XmQTmenuSavvy +Become a menu child. + + +XmQTmenuSystem +Manage a menu system. + + +XmQTnavigator +Act as a navigator to a scrollable widget. + + +XmQTscrollFrame +Handle one or more navigator widgets. + + +XmQTspecifyRenderTable +Supply the names of its default render tables. + + +XmQTtakesDefault +Change its appearance to show that it is the default button. + + +XmQTtransfer +Transfer data to other widgets and/or receive data from other +widgets + + + + +Traits are not often used in Motif application programs. +However, traits are very important to widget writers. +For complete details on traits, see the +&MotifWidGd;. + +The following table lists the names of all widgets and gadgets +in the standard Motif widget set that hold a particular trait. +For example, the following table shows that the +XmQTcontainerItem trait is held by the +XmIconGadget. +As the table suggests, some traits are held by many of the +standard Motif widgets. + + + + + + + + +Trait Installation in +Standard Widget Set + + +Trait Name +Is Installed on The Following Widgets: + + +XmQTaccessTextual +XmLabel and all its subclasses; XmLabelGadget +and all its subclasses; XmText; XmTextField + + +XmQTactivatable +XmArrowButton; XmArrowButtonGadget; XmDrawnButton; XmPushButton; +XmPushButtonGadget + + +XmQTcareParentVisual +All the subclasses of XmGadget (but not +XmGadget itself); +XmPrimitive and all its subclasses + + +XmQTcontainer +XmContainer + + +XmQTcontainerItem +XmIconGadget + + +XmQTdialogShellSavvy +XmBulletinBoard + + +XmQTjoinSide +No widgets install this trait + + +XmQTmenuSavvy +XmLabel; XmDrawnButton; XmCascadeButton; XmPushButton; +XmToggleButton; XmLabelGadget; XmCascadeButtonGadget; +XmPushButtonGadget; XmToggleButtonGadget + + +XmQTmenuSystem +XmRowColumn + + +XmQTnavigator +XmScrollBar; XmSpinBox + + +XmQTscrollFrame +XmNotebook; XmScrolledWindow + + +XmQTspecifyRenderTable +XmBulletinBoard and all its subclasses; +XmMenuShell; XmVendorShell + + +XmQTtakesDefault +XmPushButton; XmPushButtonGadget + + +XmQTtransfer +XmContainer; XmLabel and all its subclasses; +XmLabelGadget and all its subclasses; +XmList; XmScale; XmText; XmTextField + + + + +The following table lists the traits installed on each widget. +For example, the following table indicates that the +XmArrowButton widget holds both the +XmQTactivatable +and XmQTcareParentVisual traits. + + + + + + + +Trait Use by +Widget + + +Widget Name +Installs These Traits + + += + + +XmArrowButton +XmQTactivatable, XmQTcareParentVisual + + +XmArrowButtonGadget +XmQTactivatable, XmQTcareParentVisual + + +XmBulletinBoard +XmQTdialogShellSavvy, XmQTspecifyRenderTable + + +XmCascadeButton +XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, +XmQTtransfer + + +XmCascadeButtonGadget +XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, +XmQTtransfer +XmComboBox + + +XmCommand +XmQTspecifyRenderTable + + +XmContainer +XmQTcontainer, XmQTtransfer + + +XmDialogShell +None + + +XmDisplay +None + + +XmDragContext +None + + +XmDragIcon +None + + +XmDrawingArea +None + + +XmDrawnButton +XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, +XmQTmenuSavvy, XmQTtransfer + + +XmDropTransfer +None + + +XmFileSelectionBox +XmQTspecifyRenderTable + + +XmForm +XmQTspecifyRenderTable + + +XmFrame +None + + +XmGadget +None + + +XmIconGadget +XmQTcareParentVisual, XmQTcontainerItem + + +XmLabel +XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, +XmQTtransfer + + +XmLabelGadget +XmQTaccessTextual, XmQTcareParentVisual, XmQTmenuSavvy, +XmQTtransfer + + +XmList +XmQTcareParentVisual, XmQTtransfer + + +XmMainWindow + + +XmManager + + +XmMenuShell +XmQTspecifyRenderTable + + +XmMessageBox +XmQTspecifyRenderTable + + +XmNotebook +XmQTscrollFrame + + +XmPanedWindow + + +XmPrimitive +XmQTcareParentVisual + + +XmPushButton +XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, +XmQTmenuSavvy, XmQTtakesDefault, XmQTtransfer + + +XmPushButtonGadget +XmQTaccessTextual, XmQTactivatable, XmQTcareParentVisual, +XmQTmenuSavvy, XmQTtakesDefault, XmQTtransfer + + +XmRowColumn +XmQTmenuSystem + + +XmScale +XmQTtransfer + + +XmScreen + + + +XmScrollbar +XmQTcareParentVisual, XmQTnavigator + + +XmScrolledWindow +XmQTscrollFrame + + +XmSelectionBox +XmQTspecifyRenderTable + + +XmSeparator +XmQTcareParentVisual + + +XmSeparatorGadget +XmQTcareParentVisual + + +XmSpinBox +XmQTnavigator + + +XmText +XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer + + +XmTextField +XmQTaccessTextual, XmQTcareParentVisual, +XmQTtransfer + + +XmToggleButton +XmQTaccessTextual, XmQTcareParentVisual, +XmQTtransfer + + +XmToggleButtonGadget +XmQTaccessTextual, XmQTcareParentVisual, XmQTtransfer + + +VendorShell +XmQTspecifyRenderTable + + + + +The following table summarizes how the standard Motif widgets +access traits. There are two general ways for a widget to +access the traits of another widget. + +One way is for a widget to ask another widget if it holds +a particular trait. +For example, XmBulletinBoard asks each of its children widgets +if they hold the XmQTtakesDefault trait. +XmBulletinBoard calls none of the trait methods +of XmQTtakesDefault. + +Another kind of access is when one widget calls another widget's +trait method(s). +For example, XmBulletinBoard calls the +getRenderTable +trait method of the XmQTspecifyRenderTable +trait. + + + + + + + + +Trait Access By +Widget + + +Widget +Accesses These Traits: +Calls These Trait Methods: + + +XmArrowButton +None +None + + +XmArrowButtonGadget +None +None + + +XmBulletinBoard +XmQTtakesDefault +None + + +XmBulletinBoard +XmQTspecifyRenderTable +getRenderTable + + +XmCascadeButton +XmQTmenuSystem +Many + + +XmCascadeButton +XmQTspecifyRenderTable +getRenderTable + + +XmCascadeButtonGadget +XmQTmenuSystem +Many + + +XmCascadeButtonGadget +XmQTspecifyRenderTable +getRenderTable + + +XmComboBox +XmQTaccessTextual +getValue, setValue + + +XmCommand +None +None + + +XmContainer +XmQTcontainerItem +getValues, setValues + + +XmContainer +XmQTscrollFrame +getInfo + + +XmDialogShell +XmQTdialogShellSavvy +callMapUnmapCB + + +XmDisplay +None +None + + +XmDragContext +None +None + + +XmDragIcon +None +None + + +XmDrawingArea +None +None + + +XmDrawnButton +XmQTmenuSystem +Many + + +XmDrawnButton +XmQTspecifyRenderTable +getRenderTable + + +XmDropTransfer +None +None + + +XmFileSelectionBox +XmQTactivatable +None + + +XmForm +None +None + + +XmFrame +None +None + + +XmGadget +None +None + + +XmIconGadget +XmQTcontainer +getValues + + +XmIconGadget +XmQTspecifyRenderTable +getRenderTable + + +XmLabel +XmQTmenuSystem +various methods + + + +XmLabel +XmQTspecifyRenderTable +getRenderTable + + +XmLabelGadget +XmQTmenuSystem +various methods + + + +XmLabelGadget +XmQTspecifyRenderTable +getRenderTable + + +XmList +XmQTnavigator +getValues + + +XmList +XmQTscrollFrame +getInfo, init + + +XmList +XmQTspecifyRenderTable +getRenderTable + + +XmMainWindow +XmQTmenuSystem +various methods + + +XmManager +None +None + + +XmMenuShell +XmQTmenuSystem +various methods + + +XmMenuShell +XmQTspecifyRenderTable +getRenderTable + + +XmMessageBox +XmQTactivatable +None + + +XmNotebook +XmQTscrollFrame +init, addNavigator, removeNavigator + + +XmNotebook +XmQTnavigator +getValue + + +XmNotebook +XmQTactivatable +changeCB + + +XmNotebook +XmQTaccessTextual +None + + +XmPanedWindow +None +None + + +XmPrimitive +None +None + + +XmPushButton +XmQTmenuSystem +various methods + + +XmPushButton +XmQTspecifyRenderTable +getRenderTable + + +XmPushButtonGadget +XmQTmenuSystem +various methods + + +XmPushButtonGadget +XmQTspecifyRenderTable +getRenderTable + + +XmRowColumn +XmQTmenuSavvy +getAccelerator, getMnemonic, getActivateCBName + + +XmRowColumn +XmQTmenuSystem +various methods + + +XmScale +XmQTspecifyRenderTable +getRenderTable + + +XmScreen +None +None + + +XmScrollbar +None +None + + +XmScrolledWindow +XmQTnavigator +getValue + + +XmScrolledWindow +XmQTscrollFrame +init, addNavigator + + +XmSelectionBox +XmQTaccessTextual +setValue; + + +XmSelectionBox +XmQTactivatable +None + + +XmSeparator +None +None + + +XmSeparatorGadget +None +None + + +XmSpinBox +XmQTaccessTextual +setValue + + +XmText +XmQTaccessTextual +getValue, setValue + + +XmText +XmQTnavigator +getValue + + +XmText +XmQTscrollFrame +getInfo, init + + +XmText +XmQTspecifyRenderTable +getRenderTable + + +XmTextField +XmQTspecifyRenderTable +getRenderTable + + +XmToggleButton +XmQTmenuSystem +various methods + + +XmToggleButton +XmQTspecifyRenderTable +getRenderTable + + +XmToggleButtonGadget +XmQTmenuSystem +various methods + + +XmToggleButtonGadget +XmQTspecifyRenderTable +getRenderTable + + +VendorShell +XmQTspecifyRenderTable +getRenderTable + + + + + + +RELATED +The following reference pages are documented in the +&MotifWidGd;: +&cdeman.XmeTraitSet;, +&cdeman.XmeTraitGet;, +&cdeman.XmQTaccessTextual;, +&cdeman.XmQTactivatable;, +&cdeman.XmQTcareParentVisual;, +&cdeman.XmQTcontainer;, +&cdeman.XmQTcontainerItem;, +&cdeman.XmQTdialogShellSavvy;, +&cdeman.XmQTjoinSide;, +&cdeman.XmQTmenuSavvy;, +&cdeman.XmQTmenuSystem;, +&cdeman.XmQTnavigator;, +&cdeman.XmQTscrollFrame;, +&cdeman.XmQTspecifyRenderTable;, +and +&cdeman.XmQTtakesDefault;. + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR5X/UIL.sgm b/cde/imports/motif/doc/C/guides/man/PR5X/UIL.sgm new file mode 100644 index 00000000..9dbd4e69 --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR5X/UIL.sgm @@ -0,0 +1,3090 @@ + + + + + + + + + + + +UIL +file formats + + +UIL +The user interface language file format + +user interface language + + + + + + + + + + + + + + + + + + + + + +UIL + + +MODULE module_name +[ NAMES = CASE_INSENSITIVE | CASE_SENSITIVE ] +[ CHARACTER_SET = character_set ] +[ OBJECTS = { widget_name = GADGET | WIDGET; [...] } ] +{ [ +[ value_section ] | +[ procedure_section ] | +[ list_section ] | +[ object_section ] | +[ identifier_section ] +[ ... ] +] } +END MODULE; + + + +DESCRIPTION +The UIL language is used for describing the initial state of +a user interface for a widget based application. UIL describes +the widgets used in the interface, the resources of those widgets, +and the callbacks of those widgets. The UIL file is compiled into +a UID file using the command uil or by the callable compiler +Uil(). The contents of the +compiled UID file can then be accessed by the various Motif Resource +Management (MRM) functions from within an application program. + +The UID file is independent of the platform on which the Motif +program will eventually be run. In other words, the same UID file can +be used on any system that can run Motif. + + +File +A UIL file consists of a single complete module, described in the +syntax description above, or, if the file is to be included in a +larger UIL file, one complete "section," as described below. UIL uses +five different kinds of sections: value, procedure, list, object, and +identifier. + +UIL is a free-form language. This means that high-level constructs +such as object and value declarations do not need to begin in any +particular column and can span any number of lines. Low-level constructs +such as keywords and punctuation characters +can also begin in any column; however, except for string literals and comments, +they cannot span lines. + +The UIL compiler accepts input lines up to 132 characters in length. + + + +MODULE module_name + +The name by which the UIL module is known in the UID file. +This name is stored in the UID file for later +use in the retrieval of resources by the MRM. +This name is always stored in uppercase in the UID file. + + + + +NAMES = CASE_INSENSITIVE | CASE_SENSITIVE + + +UIL +case sensitivity clause + +Indicates whether names should be treated as case sensitive or case +insensitive. The default is case sensitive. +The case-sensitivity clause should be the +first clause in the module header, and in any case must precede any statement +that contains a name. +If names are case sensitive in a UIL module, UIL keywords in that module +must be in lowercase. Each name is stored in the UIL file in the same +case as it appears in the UIL module. +If names are case insensitive, then keywords +can be in uppercase, lowercase, or +mixed case, and the uppercase equivalent of each +name is stored in the UID file. + + + + +CHARACTER_SET = character_set + + +UIL +default character set clause + +Specifies the default character set for string +literals in the module that do not explicitly set +their character set. +The default character set, in the absence of this clause +is the codeset component of the LANG environment variable, +or the value of XmFALLBACK_CHARSET if LANG +is not set or has no codeset component. +The value of +XmFALLBACK_CHARSET is defined by the UIL supplier, but is +usually ISO8859-1 (equivalent to +ISO_LATIN1). +Use of this clause turns off all localized string literal processing +turned on by the compiler flag -s or the Uil_command_type +data structure element use_setlocale_flag. + + + + +OBJECTS = { widget_name = GADGET | WIDGET; } + + +UIL +objects clause + +Indicates whether the widget or gadget form of +the control specified by widget_name is used by default. +By default the widget form is used, so the gadget keyword is usually the +only one used. +The specified control should be one that has both a widget and gadget +version: XmCascadeButton, XmLabel, XmPushButton, XmSeparator, +and XmToggleButton. +The form of more than one control can be specified by delimiting them +with semicolons. +The gadget or widget form of an instance of a control can be specified +with the GADGET and WIDGET keywords in a particular +object declaration. + + + + +value_section + +Provides a way to name a value expression or literal. +The value name can then be referred to by declarations that occur +elsewhere in the UIL module in any context where a value can be used. +Values can be forward referenced. +Value sections +are described in more detail later in the reference page. + + + + +procedure_section + +Defines the callback routines used by a widget and the creation +routines for user-defined widgets. These definitions are used +for error checking. +Procedure sections +are described in more detail later in the reference page. + + + + +list_section + +Provides a way to group together a set of arguments, controls (children), +callbacks, or procedures for later use in the UIL module. +Lists can contain other +lists, so that you can set up a hierarchy to clearly +show which arguments, controls, callbacks, +and procedures are common to which widgets. +List sections +are described in more detail later in the reference page. + + + + +object_section + +Defines the objects that make up the user interface of the application. +You can reference the object names in declarations that +occur elsewhere in the UIL module in any context where an object name can +be used (for example, in a controls list, as a symbolic reference +to a widget ID, or as the tag_value argument for a callback procedure). +Objects can be forward referenced. +Object sections +are described in more detail later in the reference page. + + + + +identifier_section + +Defines a run-time binding of data to names that appear in the UIL module. +Identifier sections +are described in more detail later in the reference page. + + + + +The UIL file can also contain comments and include directives, which are +described along with the main elements of the UIL file format in +the following sections. + + + +Comments +Comments can take one of two forms, as follows: + + + +The comment is introduced with the sequence /* +followed by the text of the comment and terminated with the sequence */. +This form of comment can span multiple source lines. + + + +The comment is introduced with an ! (exclamation point), +followed by +the text of the comment and terminated by the end of the source line. + + + +Neither form of comment can be nested. + + + +Value sections + +UIL +value section +A value section consists of the keyword VALUE followed by a sequence of +value declarations. It has the following syntax: + +VALUE value_name : +[ EXPORTED | PRIVATE ] value_expression | +IMPORTED value_type ; + +Where value_expression is assigned to value_name or a +value_type is assigned to an imported value name. +A value declaration provides a way to name a value expression or literal. +The value name can be referred to by declarations that occur +later in the UIL module in any context where a value can be used. +Values can be forward referenced. +IMPORTED + +EXPORTED + +PRIVATE + + + + +EXPORTED + +A value that you define as exported is stored in the +UID file as a named resource, and therefore can be referenced by +name in other UID files. When you define a value as exported, +MRM looks outside the module in which the exported value +is declared to get its value at run time. + + + + +PRIVATE + +A private value is a value that is not imported or exported. +A value that you define as private is +not stored as a distinct resource in the UID file. +You can reference a private value only in the UIL module containing +the value declaration. The value or object is directly incorporated into +anything in the UIL module that references the declaration. + + + + +IMPORTED + +A value that you define as imported is one that is +defined as a named resource in a UID file. MRM resolves this +declaration with the corresponding exported declaration at +application run time. + + + + +By default, values and objects are private. +The following is a list of the supported value types in UIL: + + + +ANY + + + +ARGUMENT + + + +BOOLEAN + + + +COLOR + + + +COLOR_TABLE + + + +COMPOUND_STRING + + + +FLOAT + + + +FONT + + + +FONT_TABLE + + + +FONTSET + + + +ICON + + + +INTEGER + + + +INTEGER_TABLE + + + +KEYSYM + + + +REASON + + + +SINGLE_FLOAT + + + +STRING + + + +STRING_TABLE + + + +TRANSLATION_TABLE + + + +WIDE_CHARACTER + + + +WIDGET + + + + + +Procedure sections + +UIL +procedure section +A procedure section consists of the keyword PROCEDURE followed by a +sequence of procedure declarations. It has the following syntax: + +PROCEDURE + procedure_name [ ( [ value_type ]) ]; + + +UIL +procedure declaration +Use a procedure declaration to declare + + + +A routine that can be used as a +callback routine for a widget + + + +The creation function for a user-defined widget + + + +You can reference a procedure name in +declarations that occur later in the UIL module in any context +where a procedure can be used. Procedures can be forward referenced. +You cannot use a +name you used in another context as a procedure name. + +In a procedure declaration, you have the option +of specifying that a parameter will be +passed to the corresponding callback routine at run time. This parameter is +called the callback tag. You can specify the data type of the callback tag by +putting the data type in parentheses following the procedure name. When you +compile the module, the UIL compiler checks that the argument you specify in +references to the procedure is of this type. Note that the data type of the +callback tag must be one of the valid UIL data types. +You can use a widget as a callback tag, as long as the widget is defined +in the same widget hierarchy as the callback, that is they have a common +ancestor that is in the same UIL hierarchy. + +The following list summarizes how the UIL compiler checks +argument type and argument count, depending on the procedure declaration. + + + +No parameters + +No argument type or argument count checking occurs. +You can supply either 0 or one arguments in the procedure reference. + + + + +( ) + +Checks that the argument count is 0 (zero). + + + + +(ANY) + +Checks that the argument count is 1. Does +not check the argument type. Use the ANY type to prevent type +checking on procedure tags. + + + + +(type) + +Checks for one argument of the specified type. + + + + +(class_name) + +Checks for one widget argument of the specified widget class. + + + + +While it is possible to use any UIL data type to specify the type of a tag in a +procedure declaration, you must be able to represent that data type in the +programming language you are using. Some data types (such as integer, Boolean, +and string) are common data types recognized by most programming languages. +Other UIL data types (such as string tables) are more complicated and may +require that you set up an appropriate corresponding data structure in the +application in order to pass a tag of that type to a callback routine. + +You can also use a procedure declaration to specify the creation function +for a user-defined widget. In this case, you specify no formal parameters. +The procedure is invoked with the standard three arguments passed to +all widget creation functions. +(See the Motif Toolkit documentation for more information +about widget creation functions.) + + + +List sections + +UIL +list section +A list section consists of the keyword LIST followed by a +sequence of list declarations. It has the following syntax: + +LIST + list_name: { list_item; [...] } + [...] + +You can also use list sections to group together a set of arguments, controls +(children), +callbacks, or procedures for later use in the UIL module. Lists can contain other +lists, so that you can set up a hierarchy to clearly show which +arguments, controls, callbacks, and procedures are common to which widgets. +You cannot mix the different types of lists; a list +of a particular type cannot contain entries of a different list type +or reference the name of a different list type. +A list name is always private to the UIL module in which you declare +the list and +cannot be stored as a named resource in a UID file. + +The additional list types are described in the following sections. + +Arguments List Structure + + +List types +argument + +UIL +arguments list +An arguments list defines which arguments are to be specified +in the arguments list parameter when the creation routine for a particular +object is called at run time. +An arguments list also specifies +the values for those arguments. +Argument lists have the following syntax: + +LIST + list_name: ARGUMENTS { + argument_name = value_expression; + [...] } +[...] + +The argument name must be either a built-in argument name or a +user-defined argument name that is specified with the +ARGUMENT function. + +If you use a built-in argument name as an arguments list entry in an object +definition, the UIL compiler checks the argument name to be sure that it +is supported by the type of object that you are defining. If the same argument +name appears more than once in a given arguments list, the last entry +that uses that argument name supersedes all previous entries +with that name, and the compiler issues a message. + +Some arguments, such as XmNitems and XmNitemCount, +are coupled by the UIL compiler. +When you specify one of the arguments, the compiler also sets the +other. The coupled +argument is not available to you. +UIL +coupled arguments + +Arguments +coupled in UIL + + +The Motif Toolkit and the X Toolkit (intrinsics) +support constraint +arguments. +A constraint argument is one that is passed +to children of an object, beyond those +arguments normally available. +For example, the Form widget grants a set of constraint arguments to its +children. +These arguments control the position of the children within the Form. + +Unlike the arguments used to define the +attributes of a particular +widget, constraint arguments are +used exclusively to define additional attributes of the children of a +particular widget. +These attributes affect the behavior of the children +within their parent. +To supply constraint arguments to the children, +you include the arguments +in the arguments list for the +child. + +See Appendix B +for information about which arguments are supported by which widgets. See +Appendix C +for information about what the valid value type is for each built-in argument. + +Callbacks List Structure +UIL +callbacks list + +List types +callback + + +Use a callbacks list to define which callback reasons are to +be processed by a particular widget at run time. +Callback lists have the following syntax: + +LIST +list_name : CALLBACKS { +reason_name = PROCEDURE procedure_name [ ( [ value_expression ] ) ]; | +reason_name = procedure_list ; +[...] } +[...] + +For Motif Toolkit widgets, the reason name must be a built-in +reason name. For a user-defined widget, you can use a reason name +that you previously specified using the REASON function. +If you use a built-in reason in an object definition, +the UIL compiler ensures that reason is supported by the type of object +you are defining. Appendix B shows which reasons +each object supports. + +If the same reason appears more than once in a callbacks list, the last entry +referring to that name supersedes all previous entries using the same reason, +and the UIL compiler issues a diagnostic message. + +If you specify a named value for the procedure argument (callback +tag), the data type of the value must match the type specified for the callback +tag in the corresponding procedure declaration. +When specifying a widget name as a procedure value expression you must also +specify the type of the widget and a space before the name of the widget. + +Because the UIL compiler produces +a UID file rather than an object module (.o), the binding of the UIL name to +the address of the entry point to the procedure is not done by the loader, but +is established at run time with the MRM function +MrmRegisterNames. +You call this function +before fetching any objects, +giving it both the UIL names and the procedure addresses of each callback. The +name you register with MRM in the application program must match the name you +specified for the procedure in the UIL module. + +Each callback procedure receives three arguments. The first two arguments +have the same form for each callback. The form of the third argument varies +from object to object. + +The first argument is the address of the data structure maintained by the +Motif Toolkit +for this object instance. This address is called the widget ID for +this object. + +The second argument is the address of the value you specified in the +callbacks list for this procedure. If you do not specify an argument, +the address is NULL. +Note that, in the case where the value you specified is a string or an +XmString, the value specified in the callbacks list already +represents an address rather than an actual value. In the case of a +simple string, for example, the value is the address of the first +character of that string. In these cases, UIL does not add a level of +indirection, and the second argument to the callback procedure is +simply the value as specified in the callbacks list. + +The third argument is the +reason name you specified in the callbacks list. + +Controls List Structure + + +UIL +controls list +A controls list defines which objects are children of, or controlled by, +a particular object. +Each entry in a controls list has the following syntax: + +LIST + list_name: CONTROLS { + [child_name: ] [MANAGED | UNMANAGED] object_definition; + [...] } + [...] + +If you specify the keyword MANAGED at run time, the object is created and +managed; if you specify UNMANAGED at run time, the object is only created. +Objects are managed by default. + +You can use child_name to specify resources for the automatically +created children of a particular control. Names for automatically created +children are formed by appending Xm_ to the name of the child widget. +This name is specified in the documentation for the parent widget. + +Unlike the arguments list and the callbacks list, a controls list entry that is +identical to a previous entry does not supersede the previous +entry. At run time, +each controls list entry causes a child to be created when +the parent is created. If the same +object definition is used for multiple children, multiple instances of the +child are created at run time. +See Appendix B +for a list of which widget types can be +controlled by which other widget types. + +Procedures List Structure + +You can specify multiple procedures for a callback reason +in UIL by defining a procedures list. Just as +with other list types, procedures lists can be defined in-line or in +a list section and referenced by name. + +If you define a reason more than once (for example, when the reason is +defined both in a referenced procedures list and in the callbacks list for the +object), previous definitions are overridden by the latest definition. +The syntax for a procedures list is as follows: + +LIST + list_name: PROCEDURES { + procedure_name [ ( [ value_expression ]) ]; + [...] } + [...] + +When specifying a widget name as a procedure value expression you must also +specify the type of the widget and a space before the name of the widget. + + + +Object Sections + +UIL +object section +An object section consists of the keyword OBJECT followed by a +sequence of object declarations. It has the following syntax: + +OBJECT object_name: + [ EXPORTED | PRIVATE | IMPORTED ] object_type + [ PROCEDURE creation_function ] + [ object_name [ WIDGET | GADGET ] | {list_definitions } ] + + +UIL +object declaration +Use an object declaration to define the objects that are to be stored in the +UID file. You can reference the object name in declarations that +occur elsewhere in the UIL module in any context where an object name can +be used (for example, in a controls list, as a symbolic reference +to a widget ID, or as the tag_value argument for a callback procedure). +Objects can be forward referenced; that is, you can declare an object +name after you reference it. All references to an object name must be +consistent with the type of the object, as specified in the object declaration. +You can specify an object as exported, imported, or private. + +The object definition can contain a sequence of lists that define +the arguments, hierarchy, and callbacks for the widget. +You can specify only one list of each type for an object. +When you declare a user-defined widget, you must include a reference to the +widget creation function for the user-defined widget. + + +Note: Several widgets in the Motif Toolkit actually consist of two +linked widgets. For example, XmScrolledText and +XmScrolledList each consist of children XmText and +XmList widgets under a XmScrolledWindow widget. When such +a widget is created, its resources are available to both of the +underlying widgets. This can occasionally cause problems, as when the +programmer wants a XmNdestroyCallback routine named to act when +the widget is destroyed. In this case, the callback resource will be +available to both sub-widgets, and will cause an error when the widget +is destroyed. To avoid these problems, the programmer should +separately create the parent and child widgets, rather than relying on +these linked widgets. + + +Use the GADGET or WIDGET +keyword to specify the object type or to override the default variant for this +object type. +You can use the Motif Toolkit name of an object type that has a gadget +variant (for example, XmLabelGadget) as an attribute of an object +declaration. +The object_type can be any object type, including gadgets. +You need to specify the GADGET or WIDGET keyword only in the +declaration of an object, not when you reference the object. You cannot +specify the GADGET or WIDGET keyword for a +user-defined object; user-defined objects are always widgets. + + + +Identifier sections + +UIL +identifiers +The identifier section allows you to define an identifier, a mechanism that +achieves run-time binding of data to names that appear in a UIL module. +The identifier section consists of +the reserved keyword IDENTIFIER, followed by a list of names, each name followed +by a semicolon. + +IDENTIFIER identifier_name; [...;] + +You can later use these names in the UIL module as +either the value of an argument to a widget or the tag value to a callback +procedure. At run time, you use the MRM functions +MrmRegisterNames and MrmRegisterNamesInHierarchy +to bind +the identifier name with the data (or, in the case of callbacks, with +the address of the data) associated with the identifier. + +Each UIL module has a single name space; therefore, you cannot use a +name you used for a value, object, or procedure as an identifier name in +the same module. + +The UIL compiler does not do any type checking on the use of identifiers in a +UIL module. Unlike a UIL value, an identifier does not have a UIL type +associated with it. Regardless of what particular type a widget argument or +callback procedure tag is defined to be, you can use an identifier in that +context instead of a value of the corresponding type. + +To reference these identifier names in a UIL module, you use the name of +the identifier wherever you want its value to be used. + + + +Include directives + +UIL +include directive +The include directive incorporates the contents of a specified +file into a UIL module. This mechanism allows several UIL modules to share +common definitions. The syntax for the include directive is as follows: + +INCLUDE FILE file_name; + +The UIL +compiler replaces the include directive with the contents of the include file +and processes it as if these contents had appeared in the current +UIL source file. + +You can nest include files; that is, an include +file can contain include directives. +The UIL compiler can process up to 100 references (including the file +containing the UIL module). Therefore, you can include up to 99 files +in a single UIL module, including nested files. Each time a file is +opened counts as a reference, so including the same file twice counts +as two references. + +The file_name is a simple string containing a file specification +that identifies the file to be included. The rules for finding the +specified file are similar to the rules for finding header, or +.h files using the include directive, #include, with a +quoted string in C. The UIL uses the option for specifying a +search directory for include files. + + + +If you do +not supply a directory, the UIL compiler searches for the include file in the +directory of the main source file. + + + +If the compiler does not find the include +file there, the compiler looks in the same directory as the source +file. + + + +If you supply a directory, the UIL compiler searches +only that directory for the file. + + + + + + +Names and Strings +Names can consist of any of the characters A to Z, a to z, +0 to 9, $ (dollar sign), and  _  (underscore). Names cannot begin +with a digit (0 to 9). The maximum length of a name is 31 characters. + +UIL gives you a choice of +either case-sensitive or case-insensitive names through a clause +in the MODULE header. +For example, if names are case sensitive, the names "sample" and +"Sample" are distinct from each other. If names are case insensitive, +these names are treated as the same name and can be used +interchangeably. By default, UIL assumes names are case sensitive. + +In CASE-INSENSITIVE mode, the compiler outputs all names in the +UID file in uppercase form. +In CASE-SENSITIVE mode, +names appear in the UIL file +exactly as they appear in the source. + +The following table lists the reserved keywords, which are not +available for defining programmer defined names. +UIL +keywords + +UIL module +keywords + +UIL specification file +keywords + +Keywords + + + + + + + + + + +Reserved Keywords + + +ARGUMENTS +CALLBACKS +CONTROLS +END + + +EXPORTED +FALSE +GADGET +IDENTIFIER + + +INCLUDE +LIST +MODULE +OFF + + +ON +OBJECT +PRIVATE +PROCEDURE + + +PROCEDURES +TRUE +VALUE +WIDGET + + + + +The UIL unreserved keywords are described in the following list and table. +These keywords can be used as programmer defined names, +however, if you use any keyword as a name, you cannot use the UIL-supplied +usage of that keyword. + + + +Built-in argument names (for example, XmNx, XmNheight) + + + +Built-in reason names (for example, XmNactivateCallback, XmNhelpCallback) + + + +Character set names (for example, ISO_LATIN1, ISO_HEBREW_LR) + + + +Constant value names (for example, XmMENU_OPTION, XmBROWSE_SELECT) + + + +Object types (for example, XmPushButton, XmBulletinBoard) + + + + + + + + + + +Unreserved Keywords + + +ANY +ARGUMENT +ASCIZ_STRING_TABLE + + +ASCIZ_TABLE +BACKGROUND +BOOLEAN + + +CASE_INSENSITIVE +CASE_SENSITIVE +CHARACTER_SET + + +COLOR +COLOR_TABLE +COMPOUND_STRING + + +COMPOUND_STRING_COMPONENT +COMPOUND_STRING_TABLE +FILE + + +FLOAT +FONT +FONT_TABLE + + +FONTSET +FOREGROUND +ICON + + +IMPORTED +INTEGER +INTEGER_TABLE + + +KEYSYM +MANAGED +NAMES + + +OBJECTS +REASON +RGB + + +RIGHT_TO_LEFT +SINGLE_FLOAT +STRING + + +STRING_TABLE +TRANSLATION_TABLE +UNMANAGED + + +USER_DEFINED +VERSION +WIDE_CHARACTER + + +WIDGET +XBITMAPFILE + + + + +String literals can be composed of the uppercase and lowercase +letters, digits, and punctuation characters. +Spaces, tabs, and comments are special elements in the language. They are +a means of delimiting other elements, such as two names. One or more of +these elements can appear before or after any other element in the language. +However, spaces, tabs, and comments that appear in string literals are +treated as character sequences rather than delimiters. + + + +Data Types + +UIL +literals + +UIL module +literals + +UIL specification file +literals + +Values +literals + +UIL provides literals for +several of the value types it supports. Some of the value types are not +supported as literals (for example, pixmaps and string tables). You can +specify values for these types +by using functions described in the Functions section. +UIL directly supports the following literal types: + + + +String literal + + + +Integer literal + + + +Boolean literal + + + +Floating-point literal + + + +UIL also includes the data type ANY, which is used to turn off compile +time checking of data types. + + + +String Literals + +UIL +string literals + +UIL module +string literals + +UIL specification file +string literals + +Values +string literals + +A string literal is a sequence of zero or more 8-bit or 16-bit +characters or a combination +delimited by ' (single quotation marks) or " (double quotation marks). +String literals can also contain multibyte characters delimited with double +quotation marks. +String literals can be no more than 2000 characters long. + +A single-quoted string literal can span multiple source lines. To continue +a single-quoted string literal, terminate the continued line with a +\ (backslash). The literal continues with the first character +on the next line. + +Double-quoted string literals cannot span multiple source lines. +(Because double-quoted strings can contain escape sequences and other special +characters, you cannot use the backslash character to designate +continuation of the string.) To build a string value that must +span multiple source lines, use the concatenation operator described later +in this section. + +The syntax of a string literal is one of the following: + +'[character_string]' +[#char_set]"[character_string]" + +Both string forms associate a character set with a string value. +UIL uses the following rules to determine the character set and +storage format for string literals: + + + +A string declared as 'string' is equivalent to +#cur_charset"string", +where cur_charset will be the codeset +portion of the value of the LANG environment variable if it is set +or the value +of XmFALLBACK_CHARSET if LANG is not set or has no codeset +component. +By default, XmFALLBACK_CHARSET is ISO8859-1 (equivalent to +ISO_LATIN1), but vendors may define a different default. + + + +A string declared as "string" is +equivalent to #char_set"string" if +you specified char_set as the default character set for the module. +If no default character set has been specified for the module, then +if the -s option is provided to the uil command or the +use_setlocale_flag is set for the callable compiler, Uil(), the +string will be interpreted to be a string in the current locale. This means that +the string is parsed in the locale of the user by calling setlocale, its +charset is XmFONTLIST_DEFAULT_TAG, and that if the string is +converted to a compound string, it is stored as a locale encoded text segment. +Otherwise, "string" is equivalent +to #cur_charset"string", where +cur_charset is interpreted as described for single quoted strings. + + + +A string of the form "string" or +#char_set"string" is stored as a +null-terminated string. + + + +If the char_set in a string specified in the form above is not a +built-in charset, and is not a user-defined charset, the charset of +the string will be set to XmFONTLIST_DEFAULT_TAG, and an +informational message will be issued to the user to note that this +substitution has been made. + +The following table lists the character sets supported by the UIL compiler for +string literals. +Note that several UIL names map to the same character set. In +some cases, the UIL name influences how string literals are read. For example, +strings identified by a UIL character set name ending in _LR are read left-to-right. +Names that end in a different number reflect different fonts +(for example, ISO_LATIN1 or ISO_LATIN6). +All character sets in this table are represented by 8 bits. + + + + + + + +Supported Character Sets + + +UIL Name +Description + + +ISO_LATIN1 +GL: ASCII, GR: Latin-1 Supplement + + +ISO_LATIN2 +GL: ASCII, GR: Latin-2 Supplement + + +ISO_ARABIC +GL: ASCII, GR: Latin-Arabic Supplement + + +ISO_LATIN6 +GL: ASCII, GR: Latin-Arabic Supplement + + +ISO_GREEK +GL: ASCII, GR: Latin-Greek Supplement + + +ISO_LATIN7 +GL: ASCII, GR: Latin-Greek Supplement + + +ISO_HEBREW +GL: ASCII, GR: Latin-Hebrew Supplement + + +ISO_LATIN8 +GL: ASCII, GR: Latin-Hebrew Supplement + + +ISO_HEBREW_LR +GL: ASCII, GR: Latin-Hebrew Supplement + + +ISO_LATIN8_LR +GL: ASCII, GR: Latin-Hebrew Supplement + + +JIS_KATAKANA +GL: JIS Roman, GR: JIS Katakana + + + + +Following are the parsing rules for each +of the character sets: + + + +All character sets + +Character codes in the range 00...1F, 7F, and 80...9F are control characters +including both bytes of 16-bit characters. +The compiler flags these as illegal characters. + + + + +ISO_LATIN1 ISO_LATIN2 ISO_LATIN3 ISO_GREEK ISO_LATIN4 + +These sets are parsed from left to right. +The escape sequences for null-terminated strings +are also supported by these character sets. + + + + +ISO_HEBREW ISO_ARABIC ISO_LATIN8 + +These sets are parsed from right to left. For example, the string +#ISO_HEBREW"012345" will generate a primitive string of "543210" +with character set ISO_HEBREW. The string direction for such a +string would be right-to-left, so when rendered, the string will +appear as "012345." The escape sequences for null-terminated strings +are also supported by these character sets, and the characters that +compose the escape sequences are in left-to-right order. For example, +you would enter \n, not n\&npzwc;. + + + + +ISO_HEBREW_LR ISO_ARABIC_LR ISO_LATIN8_LR + +These sets are parsed from left to right. For example, the string +#ISO_HEBREW_LR"012345" generates a primitive string "012345" +with character set ISO_HEBREW. The string direction for such a +string would still be right-to-left, however, so when rendered, it +will appear as "543210." In other words, the characters were +originally typed in the same order in which they would have been +typed in Hebrew (although in Hebrew, the typist would have been using +a text editor that went from right to left). The escape sequences for +null-terminated strings are also supported by these character sets. + + + + +JIS_KATAKANA + +This set is parsed from left to right. The escape sequences +for null-terminated strings are also supported by this character +set. Note that the \ (backslash) may be displayed as a yen symbol. + + + + +In addition to designating parsing rules for strings, character set +information remains an attribute of a compound string. +If the string is included in a string consisting of +several concatenated segments, the character set information +is included with that string segment. +This gives the Motif Toolkit +the information it needs to decipher the +compound string and choose a font to display the string. + +For an application interface displayed only in English, +UIL lets you ignore the distinctions between the two uses of strings. +The compiler recognizes by context when a +string must be passed as a null-terminated string or as a compound string. + +The UIL compiler recognizes enough about the various character sets to +correctly parse string literals. +The compiler also issues errors if you use a compound +string in a context that supports only null-terminated strings. + +Since the character set names are keywords, you must +put them in lowercase if case-sensitive names are in force. +If names are case insensitive, character set names can be +uppercase, lowercase, or mixed case. + +In addition to the built-in character sets recognized by UIL, you can define +your own character sets with the CHARACTER_SET function. You can use the +CHARACTER_SET function anywhere a character set can be specified. + +String literals can contain characters with the eighth (high-order) +bit set. You cannot type control characters (00-1F, 7F, and 80-9F) +directly in a single-quoted string literal. However, you can represent these +characters with escape sequences. The following list shows the +escape sequences for special characters. + + + +UIL +escape sequences + +Escape sequences + + +\b + +Backspace + + + + +\f + +Form-feed + + + + +\n + +Newline + + + + +\r + +Carriage return + + + + +\t + +Horizontal tab + + + + +\v + +Vertical tab + + + + +\' + +Single quotation mark + + + + +\"" + +Double quotation mark + + + + +\\ + +Backslash + + + + +\integer \ + +Character whose internal representation is given by +integer (in the range 0 to 255 decimal) + + + + +Note that escape sequences are processed literally in strings that are +parsed in the current locale (localized strings). + +The UIL compiler does not process newline characters in compound +strings. +The effect of a newline character in a compound string depends only on +the character set of the string, and the result is not guaranteed to be +a multiline string. + +Compound String Literals + +A compound string consists of a string of 8-bit, 16-bit, or multibyte characters, +a named character set, and a writing direction. Its UIL data type is +compound_string. + +The writing direction of a compound string is implied by the +character set specified for the string. You can explicitly set the +writing direction for a compound string by using the COMPOUND_STRING +function. + +A compound string can consist of a sequence of concatenated compound strings, +null-terminated strings, or a combination of both, +each of which can have a different character set property and writing +direction. Use the +concatenation operator & (ampersand) to create a +sequence of compound strings. + +Each string in the sequence is stored, including +the character set and writing direction information. + +Generally, a string literal is stored in the UID file as a compound +string when the literal consists of concatenated strings having +different character sets or writing directions, or when you +use the string to specify a value for an argument that requires +a compound string value. If you want to +guarantee that a string literal is stored as a compound string, +you must use the COMPOUND_STRING function. + +Data Storage Consumption for String Literals + +The way a string literal is stored in the UID file depends on +how you declare and use the string. The UIL compiler +automatically converts a null-terminated string to +a compound string if you use the string to specify the +value of an argument that requires a compound string. +However, this conversion is costly in terms of storage +consumption. + +PRIVATE, EXPORTED, and IMPORTED string literals require +storage for a single allocation when the literal is declared; +thereafter, storage is required for each reference to the +literal. Literals declared in-line require storage +for both an allocation and a reference. + +The following table summarizes data storage consumption for +string literals. The storage requirement for an +allocation consists of a fixed portion and a variable +portion. The fixed portion of an allocation is roughly +the same as the storage requirement for a reference +(a few bytes). +The storage consumed by the variable portion +depends on the size of the literal value (that is, the +length of the string). To conserve storage space, avoid +making string literal declarations that result in an +allocation per use. + + + + + + + + + +Data Storage Consumption for String Literals + + +Declaration +Data Type +Used As +Storage Requirements + + + + + +Per Use + + +In-line +Null-terminated +Null-terminated +An allocation and a reference (within the module) + + +Private +Null-terminated +Null-terminated +A reference (within the module) + + +Exported +Null-terminated +Null-terminated +A reference (within the UID hierarchy) + + +Imported +Null-terminated +Null-terminated +A reference (within the UID hierarchy) + + +In-line +Null-terminated +Compound +An allocation and a reference (within the module) + + +Private +Null-terminated +Compound +An allocation and a reference (within the module) + + +Exported +Null-terminated +Compound +A reference (within the UID hierarchy) + + +Imported +Null-terminated +Compound +A reference (within the UID hierarchy) + + +In-line +Compound +Compound +An allocation and a reference (within the module) + + +Private +Compound +Compound +A reference (within the module) + + +Exported +Compound +Compound +A reference (within the UID hierarchy) + + +Imported +Compound +Compound +A reference (within the UID hierarchy) + + + + + + +Integer Literals + +UIL +integer literals + +UIL module +integer literals + +UIL specification file +integer literals + +Values +integer literals + +An integer literal represents the value of a whole number. +Integer literals have the form of +an optional sign followed by one or more decimal digits. +An integer literal must not contain embedded spaces or commas. + +Integer literals are stored in the UID file as 32-bit integers. +Exported and imported integer literals require a single allocation +when the literal is declared; thereafter, a few bytes of +storage are required for each reference to the literal. Private +integer literals and those declared in-line require allocation +and reference storage per use. To conserve storage +space, avoid making integer literal declarations that result +in an allocation per use. + +The following table shows data storage consumption for integer +literals. + + + + + + + +Data Storage Consumption for Integer Literals + + +Declaration +Storage Requirements Per Use + + +In-line +An allocation and a reference (within the module) + + +Private +An allocation and a reference (within the module) + + +Exported +A reference (within the UID hierarchy) + + +Imported +A reference (within the UID hierarchy) + + + + + + +Boolean Literal + +UIL +Boolean literals + +UIL module +Boolean literals + +UIL specification file +Boolean literals + +Values +Boolean literals + +Boolean literals +A Boolean literal represents the value True (reserved keyword TRUE +or On) or False (reserved keyword FALSE or Off). +These keywords are subject to case-sensitivity rules. + +In a UID file, TRUE is represented by the integer value 1 and +FALSE is represented by the integer value 0 (zero). + +Data storage consumption for Boolean literals is the same +as that for integer literals. + + + +Floating-Point Literal + +UIL +floating-point literals + +UIL module +floating-point literals + +UIL specification file +floating-point literals + +Values +floating-point literals + +A floating-point literal represents the value of a real (or float) number. +Floating-point literals have the following form: + +[+|-][integer].integer[E|e[+|-]exponent] + +For maximum portability, a floating-point literal can represent values in +the range 1.0E-37 to 1.0E+37 +with at least 6 significant digits. +On many machines this range will be wider, with more significant digits. +A floating-point literal must not contain embedded spaces or commas. + +Floating-point literals are stored in the UID file as +double-precision, floating-point numbers. +The following table +gives examples of valid and invalid floating-point +notation for the UIL compiler. + + + + + + + +Floating Point Literals + + +Valid Floating-Point Literals +Invalid Floating-Point Literals + + +1.0 +1e1 (no decimal point) + + +3.1415E−2 (equals .031415) +2.87 e6 (embedded blanks) + + +−6.29e7 (equals −62900000) +2.0e100 (out of range) + + + + +Data storage consumption for floating-point literals is +the same as that for integer literals. + + +UIL +ANY value + +UIL module +ANY value + +UIL specification file +ANY value + +Functions +ANY value + +ANY value +The purpose of the +ANY +data type is to shut off the data-type checking feature of the UIL compiler. +You can use the +ANY +data type for the following: + + + +Specifying the type of a callback procedure tag + + + +Specifying the type of a user-defined argument + + + +You can use the +ANY +data type when you need to use a type not +supported by the UIL compiler or when you want the data-type +restrictions imposed by the compiler to be relaxed. +For example, you might want to define a widget having an argument that +can accept different types of values, depending on run-time +circumstances. + +If you specify that an argument takes an +ANY +value, the compiler does not +check the type of the value specified for that argument; therefore, you +need to take care when specifying a value for an argument of type +ANY. +You could get unexpected results at run time if you pass a value having +a data type that the widget does not support for that argument. + + + +Expressions + +UIL +expressions + +expressions +UIL includes compile-time value expressions. These expressions +can contain references to other UIL values, but cannot be +forward referenced. + +The following table lists the set of operators in UIL that allow +you to create integer, real, and Boolean values based on other values +defined +with the UIL module. In the table, a precedence of 1 is the highest. + + + + + + + + + +Valid Operators + + +Operator +Operand Types +Meaning +Precedence + + +~ +Boolean +NOT +1 + + + +integer +One's complement + + + +- +float +Negate +1 + + + +integer +Negate + + + ++ +float +NOP +1 + + + +integer +NOP + + + +* +float,float +Multiply +2 + + + +integer,integer +Multiply + + + +/ +float,float +Divide +2 + + + +integer,integer +Divide + + + ++ +float,float +Add +3 + + + +integer,integer +Add + + + +− +float,float +Subtract +3 + + + +integer,integer +Subtract + + + +>> +integer,integer +Shift right +4 + + +<< +integer,integer +Shift left +4 + + +& +Boolean,Boolean +AND +5 + + + +integer,integer +Bitwise AND + + + + +string,string +Concatenate + + + +| +Boolean,Boolean +OR +6 + + + +integer,integer +Bitwise OR + + + +⁁ +Boolean,Boolean +XOR +6 + + + +integer,integer +Bitwise XOR + + + + + +A string can be either a single compound string or a sequence of +compound strings. If the two +concatenated strings have different properties (such as writing +direction or character set), the result of the concatenation is a +multisegment compound string. + +The string resulting from the concatenation is a null-terminated string +unless one or more of the following conditions exists: + + + +One of the operands is a compound string + + + +The operands have different character set properties + + + +The operands have different writing directions + + + +Then the resulting string is a compound string. +You cannot use imported or exported values as operands of the concatenation +operator. + +The result of each operator has the same type as its operands. +You cannot mix types in an expression without using conversion routines. + +You can use parentheses to override the normal precedence of operators. +In a sequence of unary operators, the operations are performed in +right-to-left +order. For example, − + −A is equivalent to −(+(−A)). +In a sequence of binary operators of the same precedence, the operations +are performed in left-to-right order. For example, A*B/C*D is +equivalent to ((A*B)/C)*D. + +A value declaration gives a value a name. You cannot redefine the value +of that name in a subsequent value declaration. +You can use a value containing operators and functions anywhere you can +use a value in a UIL module. +You cannot use imported values as operands in expressions. +UIL +data type conversions + +Data type +conversions + +Conversions +data type + + +Several of the binary operators are defined for multiple data types. +For example, the operator for multiplication (*) is defined for both +floating-point and integer operands. + +For the UIL compiler to perform these binary operations, both +operands must be of the same type. +If you supply operands of different data types, the UIL compiler +automatically converts one of the operands to the type of the other +according to the following conversions rules: + + + +If the operands are an integer and a Boolean, the Boolean is converted +to an integer. + + + +If the operands are an integer and a floating-point, the integer is converted +to an floating-point. + + + +If the operands are a floating-point and a Boolean, the Boolean is converted +to a floating-point. + + + +You can also explicitly convert the data type of a value by using +one of the conversion functions INTEGER, FLOAT or +SINGLE_FLOAT. + + + +Functions + +UIL Functions + +UIL module +functions + +UIL specification file +functions + +Functions +UIL provides functions to generate the following types of values: + + + +Character sets + + + +Keysyms + + + +Colors + + + +Pixmaps + + + +Single-precision, floating-point numbers + + + +Double-precision, floating-point numbers + + + +Fonts + + + +Fontsets + + + +Font tables + + + +Compound strings + + + +Compound string tables + + + +ASCIZ (null-terminated) string tables + + + +Wide character strings + + + +Widget class names + + + +Integer tables + + + +Arguments + + + +Reasons + + + +Translation tables + + + +Remember that all examples in the following sections assume case-insensitive +mode. Keywords are shown in uppercase letters to distinguish them +from user-specified names, which are shown in lowercase letters. +This use of uppercase letters is not required in case-insensitive +mode. In case-sensitive mode, keywords +must be in lowercase letters. + + + +CHARACTER_SET(string_expression[, property[, ...]]) + + +UIL +user-defined character set + +UIL module +user-defined character set + +UIL specification file +user-defined character set + +UIL Functions +CHARACTER_SET + +User-defined character set + +Character set +user-defined + +CHARACTER_SET function + +You can define your own character sets with the CHARACTER_SET function. You +can use the CHARACTER_SET function anywhere a character set can be specified. + +The result of the CHARACTER_SET function is a character set with the name +string_expression and the properties you specify. +string_expression must be a +null-terminated string. You can optionally include one or both of the following +clauses to specify properties for the resulting character set: + +RIGHT_TO_LEFT = boolean_expression +SIXTEEN_BIT = boolean_expression + +The RIGHT_TO_LEFT clause sets the default writing direction of the string from +right to left if boolean_expression is True, and right to left otherwise. + +The SIXTEEN_BIT clause allows the strings associated with this character set to +be interpreted as 16-bit characters if boolean_expression is True, +and 8-bit characters otherwise. + + + + +KEYSYM(string_literal) + + +UIL +keysyms + +UIL module +keysyms + +UIL specification file +keysyms + +UIL Functions +KEYSYM + +Keysyms +defining in UIL + +The KEYSYM function is used to specify a keysym for a mnemonic resource. +string_literal must contain a valid KeySym name. +(See XStringToKeysym(3 X11) for more information.) + + + + +COLOR(string_expression[,FOREGROUND|BACKGROUND]) + + +UIL +color values + +UIL module +color values + +UIL specification file +color values + +UIL Functions +COLOR + +Color values +defining in UIL + +The COLOR function supports the definition of colors. +Using the COLOR function, you can designate a value to specify a color +and then use that value for arguments requiring a color value. +The string expression +names the color you want to define; +the optional keywords FOREGROUND and BACKGROUND identify how the color is +to be displayed on a monochrome device when the color is used in the +definition of a color table. + +The UIL compiler does not +have built-in color names. Colors are a server-dependent attribute of +an +object. Colors are defined on each server and may have different red-green-blue (RGB) +values on each server. The string you specify as the +color argument must be recognized by the server on which +your application runs. + +In a UID file, UIL represents a color as a character string. +MRM calls X translation routines +that convert a color string to the device-specific pixel value. If you +are running on a monochrome server, all colors translate to black or +white. +If you are on a color server, the color names translate to their proper +colors if the following conditions are met: + + + +The color is defined. + + + +The color map is not yet full. + + + +If the color map is full, even valid colors translate to black or white +(foreground or background). + +Interfaces do not, in general, specify colors for widgets, +so that the selection of colors can be controlled by the +user through the .Xdefaults +file. + +To write an application that runs on both monochrome and color devices, you +need to specify which colors in a color table (defined with the COLOR_TABLE +function) +map to the background and which colors map to the foreground. +UIL lets you use the COLOR function to designate this mapping in the definition of the color. +The following example +shows how to use the COLOR function to map +the color red to the background color on a monochrome device: + + +VALUE c: COLOR ( 'red',BACKGROUND ); + + +The mapping comes into play only when the MRM is +given a color and the +application is to be displayed on a monochrome device. In this case, +each color is considered to be in one of the following three categories: + + + +The color is mapped to the background color on the monochrome device. + + + +The color is mapped to the foreground color on the monochrome device. + + + +Monochrome mapping is undefined for this color. + + + +If the color is mapped to the +foreground or background color, MRM substitutes the +foreground or background color, respectively. If you do not specify the +monochrome mapping for a color, MRM passes the color string +to the Motif Toolkit +for mapping to the foreground or background color. + + + + +RGB(red_integer, green_integer, blue_integer) + + +UIL +color values + +UIL module +color values + +UIL specification file +color values + +UIL Functions +RGB + +Color values +defining in UIL + +The three integers define the values for the red, green, and blue +components of the color, in that order. The values of these +components can range from 0 to 65,535, inclusive. +The values may be +represented as integer expressions. + +In a UID file, UIL represents an RGB value as three integers. +MRM calls X translation routines that +convert the integers to the device-specific pixel value. +If you are running on a monochrome server, all colors translate to +black or white. +If you are on a color server, RGB values translate to their proper +colors if the colormap is not yet full. +If the colormap is full, values translate to black or white (foreground +or background). + + + + +COLOR_TABLE(color_expression='character'[,...]) + + +COLOR_TABLE Function + +The color expression +is a previously defined color, a color defined in line +with the COLOR function, or the phrase +BACKGROUND COLOR or FOREGROUND COLOR. The character +can be any valid UIL character. + +The COLOR_TABLE function provides a device-independent way to +specify a set of colors. +The COLOR_TABLE function accepts either +previously defined UIL color names or in line +color definitions (using the COLOR function). +A color table must be private because its +contents must be known by the UIL compiler to construct an icon. The +colors within a color table, however, can be imported, exported, or +private. + +The single letter associated with each color is the character you +use to represent that color when creating an icon. +Each letter used to represent a color must be unique within the +color table. + + + + +ICON([COLOR_TABLE=color_table_name,] row[,...) + +color-table-name must refer to a previously defined color table, +and row is a character expression giving one row of the icon. + +The ICON function describes a rectangular icon that is x pixels wide +and y pixels high. +The strings surrounded by single quotation marks describe +the icon. +Each string represents a row in the icon; +each character in the string represents a pixel. + +The first row in an icon definition determines the width of the icon. +All rows must have the same number of characters as the first row. +The height of the icon is dictated by the number of rows. +The maximum number of rows is 999. + +The first argument of the ICON function +(the color table specification) is optional and identifies the colors that are +available in this icon. +By using the single letter associated with +each color, you can specify the color of each pixel in the icon. +The icon must be constructed of characters +defined +in the specified color table. + +A default color table is used if you omit the argument specifying the color +table. To make use of the default color table, the rows of your icon +must contain only spaces and asterisks. +The default color table is defined as follows: + + +COLOR_TABLE( BACKGROUND COLOR = ' ', FOREGROUND COLOR = '*') + + +You can define other characters to represent the background color and +foreground color by replacing the space and asterisk in the BACKGROUND COLOR +and FOREGROUND COLOR clauses shown in the previous statement. +You can specify icons as private, imported, or exported. +Use the MRM function +MrmFetchIconLiteral +to retrieve an exported icon at run +time. + + + + +XBITMAPFILE(string_expression) + +The XBITMAPFILE function is similar to the ICON function in that both +describe a rectangular icon that is x pixels wide and y pixels high. +However, XBITMAPFILE allows you to specify an external file containing the +definition of an X bitmap, whereas all ICON function definitions must be +coded directly within UIL. X bitmap files can be generated by +many different X applications. +UIL reads these files through the XBITMAPFILE function, but does +not support creation of these files. +The X bitmap file specified as the argument +to the XBITMAPFILE function is read at application run time by MRM. + +The XBITMAPFILE function returns a value of type +pixmap +and can be used +anywhere a pixmap data type is expected. + + + + +SINGLE_FLOAT(real_number_literal) + + +UIL +floating-point values + +UIL module +floating-point values + +UIL specification file +floating-point values + +UIL Functions +SINGLE_FLOAT + +Floating-point values + +The SINGLE_FLOAT function lets you store floating-point literals in UIL +files as single-precision, floating-point numbers. +Single-precision floating-point numbers can often be stored using less +memory than double-precision, floating-point numbers. +The real_number_literal can be either an integer literal or a +floating-point literal. + + + + +FLOAT(real_number_literal) + + +UIL +floating-point values + +UIL module +floating-point values + +UIL specification file +floating-point values + +UIL Functions +FLOAT + +Floating-point values + +The FLOAT function lets you store floating-point literals in UIL files +as double-precision, floating-point numbers. +The real_number_literal can be either an integer literal or a +floating-point literal. + + + + +FONT(string_expression[, CHARACTER_SET=char_set]) + + +UIL +font values + +UIL module +font values + +UIL specification file +font values + +UIL Functions +FONT + +Font values + +You define fonts with the FONT function. +Using the FONT function, +you designate a value to specify a font +and then use that value for arguments that require a font value. +The UIL compiler has no built-in fonts. + +Each font makes sense only in the context of a character set. +The FONT function has an additional +parameter to let you specify the character set +for the font. +This parameter is optional; if you omit it, +the default character set depends on the value of the LANG environment +variable if it is set, or on the value of XmFALLBACK_CHARSET if LANG +is not set. + +string_expression specifies the name of the font +and the clause CHARACTER_SET = char_set +specifies the character set for the font. +The string expression used in the FONT function cannot be a compound string. + + + + +FONTSET(string_expression[,...][, CHARACTER_SET=charset]) + + +UIL +fontset value + +UIL module +fontset value + +UIL specification file +fontset value + +Functions +fontset value + +UIL Functions +FONT_TABLE + +fontset value +defining + +You define fontsets with the FONTSET function. +Using the FONTSET function, +you designate a set of values to specify fonts +and then use those values for arguments that require a fontset. +The UIL compiler has no built-in fonts. + +Each font makes sense only in the context of a character set. +The FONTSET function has an additional +parameter to let you specify the character set +for the font. +This parameter is optional; if you omit it, +the default character set depends on the value of the LANG environment variable if it is set, or on the value of XmFALLBACK_CHARSET if LANG +is not set. + +The string expression specifies the name of the font +and the clause CHARACTER_SET = char_set +specifies the character set for the font. +The string expression used in the FONTSET function cannot be a compound string. + + + + +FONT_TABLE(font_expression[,...]) + + +UIL +font table value + +UIL module +font table value + +UIL specification file +font table value + +Functions +font table value + +UIL Functions +FONT_TABLE + +Font table value +defining + +A font table is a sequence of pairs of fonts and character sets. At run time, +when an object needs to display a string, the object +scans the font table for the character set that +matches the character set of the string to be displayed. +UIL +provides the FONT_TABLE function to let you supply such an argument. +font_expression is created with the FONT and FONTSET functions. + +If you specify a single font value to specify an argument that requires +a font table, the UIL compiler automatically converts a font value to a font +table. + + + + +COMPOUND_STRING(string_expression[,property[,...]]) + +Use the COMPOUND_STRING function to set properties of a +null-terminated string and to convert it into a compound string. The +properties you can set are the writing direction and separator. + +The result of the COMPOUND_STRING function is a compound string +with the string expression as its value. You can optionally include +one or more of the following clauses to specify properties for the +resulting compound string: + +RIGHT_TO_LEFT = boolean_expression +SEPARATE = boolean_expression + +The RIGHT_TO_LEFT clause sets the writing direction of the +string from right to left if boolean_expression +is True, and left to right otherwise. +Specifying this argument does not cause the value +of the string expression to change. +If you omit the RIGHT_TO_LEFT argument, the resulting string has the same +writing direction as string_expression. + +The SEPARATE clause appends a separator to the end of the compound string if +boolean_expression is True. If you omit the SEPARATE +clause, the resulting string does not have a separator. + +You cannot use imported or exported values as the operands of the +COMPOUND_STRING function. + + + + +COMPOUND_STRING_COMPONENT(component_type [, {string | enumval}]) + +Use the COMPOUND_STRING_COMPONENT function to create compound strings +in UIL consisting of single components. +This function is analagous to XmStringComponentCreate. +This function lets you create simple compound strings containing +components such as XmSTRING_COMPONENT_TAB and +XmSTRING_COMPONENT_RENDITION_BEGIN which are not produced by +the COMPOUND_STRING function. These components +can then be concatenated to other compound strings to build more +complex compound strings. + +The first argument must be an XmStringComponentType +enumerated constant. +The type and interpretation of the second argument depends +on the first argument. +For example, if you specify any of the following enumerated +constants for the first argument, then you should not specify +a second argument: +XmSTRING_COMPONENT_SEPARATOR, +XmSTRING_COMPONENT_LAYOUT_POP, +XmSTRING_COMPONENT_TAB, +and +XmSTRING_COMPONENT_LOCALE. +However, if you specify an enumerated constant from the following +group, then you must supply a string as the second argument: +XmSTRING_COMPONENT_CHARSET, +XmSTRING_COMPONENT_TEXT, +XmSTRING_COMPONENT_LOCALE_TEXT, +XmSTRING_COMPONENT_WIDECHAR_TEXT, +XmSTRING_COMPONENT_RENDITION_BEGIN, +and +XmSTRING_COMPONENT_RENDITION_END. +If you specify +XmSTRING_COMPONENT_DIRECTION +as the first argument, then you must specify an XmStringDirection +enumerated constant as the second argument. +Finally, if you specify +XmSTRING_COMPONENT_LAYOUT_PUSH +as the first argument, then you must specify an XmDirection +enumerated constant as the second argument. + +The compound string components +XmSTRING_COMPONENT_RENDITION_BEGIN, and +XmSTRING_COMPONENT_RENDITION_END take, for their argument, the +"tag," or name, of a rendition from the current render table. See the +following section for more information about how to specify a render +table. + + + + +COMPOUND_STRING_TABLE(string_expression[,...]) + +A compound string table is an array +of compound strings. Objects requiring a list of string values, such +as the XmNitems and XmNselectedItems +arguments for the list widget, use string table values. The +COMPOUND_STRING_TABLE function builds the values +for these two arguments of the list widget. The COMPOUND_STRING_TABLE +function generates a value of type string_table. +The name STRING_TABLE is a synonym for COMPOUND_STRING_TABLE. + +The strings inside the string table must be simple strings, which the UIL +compiler automatically converts to compound strings. + + + + +ASCIZ_STRING_TABLE(string_expression[,...]) + +An ASCIZ string table is an array of ASCIZ (null-terminated) string +values separated by commas. This function allows you to pass more than one +ASCIZ string as a callback tag value. The ASCIZ_STRING_TABLE function +generates a value +of type +asciz_table. +The name ASCIZ_TABLE is a synonym for ASCIZ_STRING_TABLE. + + + + +WIDE_CHARACTER(string_expression) + + +UIL +wide character strings + +UIL module +wide character strings + +UIL specification file +wide character strings + +UIL Functions +WIDE_CHARACTER + +wide character strings +defining in UIL + +Use the WIDE_CHARACTER function to generate a wide character +string from null-terminated string in the current locale. + + + + +CLASS_REC_NAME(string_expression) + + +UIL +widget class names + +UIL module +widget class names + +UIL specification file +widget class names + +UIL Functions +CLASS_REC_NAME + +widget class names +defining in UIL + +Use the CLASS_REC_NAME function to generate a widget class name. +For a widget class defined by the toolkit, the string argument is the +name of the class. +For a user-defined widget, the string argument is the name of the +creation routine for the widget. + + + + +INTEGER_TABLE(integer_expression[,...]) + +An integer table is an array of integer values separated by commas. +This function allows you to pass more than one integer per callback +tag value. +The INTEGER_TABLE function generates a value of type +integer_table. + + + + +ARGUMENT(string_expression[, argument_type]) + + +UIL +argument values + +UIL module +argument values + +UIL specification file +argument values + +UIL Functions +ARGUMENT + +Argument values +defining in UIL + +The ARGUMENT function defines the arguments to a user-defined widget. +Each of the objects that can be described by UIL permits a set of arguments, +listed in Appendix B. For example, +XmNheight +is an argument to most objects and has an integer data type. To specify +height for a user-defined widget, you can use the built-in argument +name +XmNheight, +and specify an integer value when you declare the user-defined widget. +You do not use the ARGUMENT function to specify arguments that are +built into the UIL compiler. + +The string_expression name +is the +name the UIL compiler uses for the argument in the UID file. +argument_type +is the type of value that can be +associated with the argument. If you omit the second argument, the default +type is +ANY +and no value type checking occurs. Use one of the following keywords +to specify the argument type: + + + +ANY + + + +ASCIZ_TABLE + + + +BOOLEAN + + + +COLOR + + + +COMPOUND_STRING + + + +FLOAT + + + +FONT + + + +FONT_TABLE + + + +FONTSET + + + +ICON + + + +INTEGER + + + +INTEGER_TABLE + + + +KEYSYM + + + +PIXMAP + + + +REASON + + + +SINGLE_FLOAT + + + +STRING + + + +STRING_TABLE + + + +TRANSLATION_TABLE + + + +WIDE_CHARACTER + + + +WIDGET + + + +You can use the ARGUMENT function to allow the UIL compiler to recognize +extensions to the Motif Toolkit. For example, an existing widget +may accept a new argument. Using the ARGUMENT function, you can make +this new argument available to the UIL compiler before the updated +version of the compiler is released. + + + + +REASON(string_expression) + + +UIL +reason value + +UIL Functions +reason value + +UIL module +reason value + +UIL specification file +reason value + +Functions +reason value + +Reason value + +The REASON function is useful for defining new reasons for user-defined +widgets. + +Each of the objects in the +Motif Toolkit defines a set of conditions under which it calls a +user-defined function. These conditions are known as callback reasons. +The user-defined functions are termed callback procedures. In a UIL +module, you use a callbacks list to specify which user-defined +functions are to be called for which reasons. + +Appendix B lists the callback reasons +supported by the Motif Toolkit +objects. + +When you declare a user-defined widget, you can define callback reasons +for that widget using the REASON function. +The string expression specifies the argument name stored in the UID +file for the reason. This reason name is supplied to the widget +creation routine at run time. + + + + +TRANSLATION_TABLE(string_expression[,...]) + + +UIL +translation table value + +UIL module +translation table value + +UIL specification file +translation table value + +Functions +translation table value + +Translation table value + +Each of the Motif Toolkit +widgets has a translation table that maps +X events (for example, mouse button 1 being pressed) to a sequence +of actions. Through widget arguments, such as the common translations argument, +you can specify an alternate set of events or actions for a particular widget. +The TRANSLATION_TABLE function creates a translation table that can be used as +the value of an argument that is of the data type translation_table. + +You can use one of the following translation table directives with the +TRANSLATION_TABLE function: #override, #augment, or #replace. +The default is #replace. +If you specify one of these directives, it must be the first entry in +the translation table. + +The #override directive causes any duplicate translations to be ignored. +For example, if a translation for <Btn1Down> is already defined in the +current translations for a PushButton, the translation defined by +new_translations overrides the current definition. +If the #augment directive is specified, the current definition takes +precedence. +The #replace directive replaces all current translations with those +specified in the XmNtranslations resource. + + + + + + + +Renditions and Render Tables + +Renditions + +Render Tables + +In addition to the string direction, each compound string carries a +great deal of information about how its text is to be rendered. Each +compound string contains a "tag," identifying the "rendition" to be +used to draw that string. The rendition contains such information as +the font, the size, the color, whether the text is to be underlined or +crossed out, and the position and style of any tab stops. Many +renditions are combined into a "render table," which is specified to +any widget with the XmNrenderTable resource, and in the widget's +controls list. + +UIL implements render tables, renditions, tab lists, and tab stops as +a special class of objects, in a form similar to the widget +class. These objects are not themselves widgets or gadgets, but the +format used by UIL to specify widget resources provides a convenient +way to specify the qualities and dependencies of these objects. + +For example, a render table, included in some widget's controls +list, must also have a controls list in its specification, +containing the names of its member renditions. Each rendition, in its +specification, will contain an arguments list specifying such +qualities as the font, the color, and whether the text is to be +underlined. Any of the renditions may also control a tablist, which +will itself control one or more tab stops. + +Please refer to the &MotifProgGd; for a complete +description of renditions and render tables, and for an example of how +to use them in UIL. + + + + +RELATED INFORMATION +&cdeman.uil;, &cdeman.Uil3; + + + + diff --git a/cde/imports/motif/doc/C/guides/man/PR5X/WML.sgm b/cde/imports/motif/doc/C/guides/man/PR5X/WML.sgm new file mode 100644 index 00000000..c9327d0d --- /dev/null +++ b/cde/imports/motif/doc/C/guides/man/PR5X/WML.sgm @@ -0,0 +1,700 @@ + + + + + + + + + + + +WML +file formats + + +WML +The widget meta-language file format for creating uil compilers + +widget meta-language + + + + + + + + + + + + + + + + + + + + + +WML + + +DESCRIPTION +The widget meta-language facility (WML) is used to generate the +components of the user interface language (UIL) compiler that +can change depending on the widget set. Using WML you can add support +in UIL for +new widgets to the Motif widget set or for a totally new widget set. + + +File +WML files are ASCII files that you can modify with any standard +text editor. They are accessed in the +tools/wml directory by WML. +By convention WML files have the suffix &npzwc;.wml. +The Motif widget set is described in the +motif.wml file. +This is also the default WML file when using the WML facility. + +When adding new widgets or changing widget characteristics, you should +start with a copy of the +motif.wml file. +If you are creating a new widget set for use with UIL, you should +start from scratch. +In either case the +motif.wml +file is a good example of WML syntax, and you should familiarize +yourself with it before writing your own WML file. + +WML files have a simple syntax, similar in structure to UIL. +It is made up of the following elements: + + + +Comments + + + +Data Type Definitions + + + +Character Set Definitions + + + +Enumeration Set Definitions + + + +Control List Definitions + + + +Class Definitions + + + +Child Definitions + + + +Resource Definitions + + + +You can use space, tabs, or newlines anywhere in the syntax, +as long as you do not split up keywords or strings, except that +comments end at a newline. +The order of elements is not important to the syntax. + +This description uses the following additional conventions +to describe the syntax of the widget meta-language: + + + +[  ] + +Indicates optional elements. + + + + +... + +Indicates where an element of syntax can be repeated. + + + + +| + +Indicates a choice among multiple items. + + + + + + +Comments +You can include comments in the WML file. +Comments have the following syntax: + +[any.element]!any.comment + +Comments begin with an exclamation point and extend to the +end of the line. A comment can begin on a line by itself or +follow any part of another element. A comment does not change +the meaning of any other element. +For example: + + +!This is a comment +! that spans two lines. +DataType !This is a comment following code. + + + + +Data Type Definitions +Data type definitions register all the resource data +types used in the file. You must register all the data types used +in your WML file. +Data type definitions have the following syntax: + +DataType + any.datatype [{ InternalLiteral = internal.name | + DocName = "string"; [...]}]; + [...] + +A data type definition begins with the keyword DataType. Following +the +DataType keyword is a list of data types that can be further modified with + + + +InternalLiteral + +This forces the value of the internal symbol table literal definition +of the data type name. This modifier is only used to get around +symbol table definitions hard coded into the UIL compiler. +It should rarely be used. + + + + +DocName + +This gives an arbitrary string for use in the documentation. +This string is meant to supply a different name for the data type for +use in the documentation, or a single name for the data type if the +data type has aliases. + + + + +For example: + + +DataType OddNumber {DocName="OddNumber";}; + NewString; + + + + +Character Set Definitions +Character set definitions register the Motif Toolkit name and other +information for the character set names used in UIL. +Character set definitions have the following syntax: + +CharacterSet + any.character.set + { [ FontListElementTag | XmStringCharsetName ] = "string"; + [ Alias = "string" ...; | + Direction = [ LeftToRight | RightToLeft ]; | + ParseDirection = [ LeftToRight | RightToLeft ]; | + CharacterSize = [ OneByte | TwoByte ]; ] + [ ... ] }; + [ ... ] + +A character set definition begins with the keyword CharacterSet. +Following the CharacterSet keyword is a list of character sets +that can be further modified with + + + +FontListElementTag | XmStringCharsetName + +Specifies the name of the character set, which will become the character +set component of a compound string segment created using this +character set. +This modifier is required. + + + + +Alias + +Specifies one or more aliases for the character set name. +Each alias can be used within UIL to refer to the same character set. + + + + +Direction + +Specifies the direction of a compound string segment created using +this character set. +The default is LeftToRight. + + + + +ParseDirection + +Specifies the direction in which an input string is parsed when a +compound string segment is created using this character set. +The default is whatever Direction is specified. + + + + +CharacterSize + +Specifies the number of bytes in each character of a compound string +segment created using this character set. +The default is OneByte. + + + + +For example: + + +CharacterSet + iso_latin1 + { XmStringCharsetName = "ISO8859-1"; + Alias = "ISOLatin1"; }; + iso_hebrew_lr + { XmStringCharsetName = "ISO8859-8"; + Alias = "iso_latin8_lr"; + Direction = RightToLeft; + ParseDirection = LeftToRight; }; + ksc_korean + { XmStringCharsetName = "KSC5601.1987-0"; + CharacterSize = TwoByte; }; + + + + +Enumeration Set Definitions +Enumeration set definitions register the named constants used in the +Motif Toolkit to specify some resource values. +Enumeration set definitions have the following syntax: + +EnumerationSet + resource.name: resource.type + { enum.value.name; [ ... ] }; + +An enumeration set definition begins with the keyword +EnumerationSet. +For each enumeration set defined, the name and type of the resource are +listed. +The resource name is the Motif Toolkit resource name, with the beginning +XmN removed and with the initial letter capitalized. +For example, the name of the Motif Toolkit resource +XmNrowColumnType is RowColumnType. +The resource type is the data type for the resource; for most resources, +this is integer. +Following the resource name and type is a list of names of enumeration +values that can be used as settings for the resource. +These names are the same as those in the Motif Toolkit. + +For example: + + +EnumerationSet + RowColumnType: integer + { XmWORK_AREA; XmMENU_BAR; XmMENU_POPUP; + XmMENU_PULLDOWN; XmMENU_OPTION; }; + + +Enumeration sets also support Boolean values. + + + +Control List Definitions +Control list definitions assign a name to groups of controls. +You can use these control lists later in class definitions to simplify +the structure of your WML file. +Control list definitions have the following syntax: + +ControlList + any.control.list [{ any.control; [...]}]; + +A control list definition starts with the +ControlList keyword. +Following the +ControlList keyword are any number of control list definitions. Control list +definitions are made up of a control list name followed by the +set of controls it represents. For example: + + +ControlList + Buttons {PushButton; + RadioButton; + CascadeButton; + NewCascadebutton;}; + + +Each control specified in the control list must be defined as +a class in the file. + + + +Class Definitions +Class definitions describe a particular widget class including +its position in the class hierarchy, toolkit convenience function, +resources, and controls. There should be one class definition for +each widget or gadget in the widget set you want to support in UIL. +Class definitions have the following syntax: + +Class class.name: MetaClass | Widget | Gadget + [{[ + SuperClass = class.name; | + ParentClass = parent.class.name; | + InternalLiteral = internal.name; | + Alias = alias; | + ConvenienceFunction = convenience.function; | + WidgetClass = widget.class; | + DocName = "string"; | + DialogClass = True | False; | + Resources { any.resource.name [{ + Default = new.default.value; | + Exclude = True | + False; + [...]} ]; + [...]}; | + Controls { any.control.name; [...]}; + Children { any.child.name; [...] }; + [...] + ]}]; + +Class definitions start with the +Class keyword. +For each class defined, the name of the class and whether the +class is a metaclass, widget, or gadget is listed. +Each class definition can be further modified with the +keywords described in the following list. + + + +SuperClass + +This indicates the name of the parent class. +Only the root of the hierarchy does not specify a SuperClass. + + + + +ParentClass + +This indicates the name of the widget's automatically created +parent class if one exists. This allows resources for that +automatically created class to be used in instances of this class. +For example, XmBulletinBoardDialog creates both an +XmBulletinBoard and an XmDialogShell. To access the +resources of the XmDialogShell parent class it must be +specified here. + + + + +InternalLiteral + +This forces the value of the internal symbol table literal definition +of the class name. This modifier is only used to get around +symbol table definitions hard coded into the UIL compiler. +It should rarely be used. + + + + +Alias + +This indicates alternate names for the class +for use in a UIL specification. + + + + +ConvenienceFunction + +This indicates the name of the creation convenience function +for this class. All widget and gadget classes must have a +ConvenienceFunction. + + + +WidgetClass + +This indicates the associated widget class of gadget type classes. +Presently, nothing is done with this value. + + + + +DocName + +This defines an arbitrary string for use in the documentation. +Presently, nothing is done with this value. + + + + +DialogClass + +This indicates whether the class is a dialog class. +Presently, nothing is done with this value. + + + + +Resources + +This lists the resources of the widget class. This keyword +can be further modified with + + + +Default + +This specifies a new default value for this resource. Resource +default values are usually set in the resource definition. If +an inherited resource's default value is changed by the class, +the new default value should be noted here. + + + + +Exclude + +This specifies whether an inherited resource should be excluded from the +resource list of the class. Exclude is False by default. + + + + + + + +Children + +This lists the names of the automatically created children of this +class, so that those children can be accessed in the UIL file. + + + + +Controls + +This lists the controls that the widget class allows. The controls can +be other classes or a control list from the control list definition. + + + + +The following example uses the examples from the data type definitions and +control list definitions above. + + +Class + TopLevelWidget: MetaClass + { + Resources + { + XtbNfirstResource; + XtbNsecondResource; + }; + }; + NewWidget: Widget + { + SuperClass = TopLevelWidget; + ConvenienceFunction = + XtbCreateNewWidget; + Resources + { + XtbNnewResource; + XtbNfirstResource + {Default="XtbNEW_VALUE";}; + XtbNsecondResource + {Exclude=True;}; + }; + Controls + { + NewWidget; + Buttons; + }; + }; + + + + +Child Definitions +Child definitions register the classes of automatically created +children. Automatically created children are referenced elsewhere in +a uil file using the Children keyword within a class definition. +Child definitions have the following syntax: + +Child +child.name : class.name; +[...] + +Where child.name is the name of the automatically created child +and class.name is the name of the class of that child. + + + +Resource Definitions +Resource definitions describe a particular resource including +its type, and default value. +There should be a resource definition for +each new resource referenced in the class definitions. +Resource definitions have the following syntax: + +Resource + resource.name: Argument | Reason | Constraint | SubResource + [{[ + Type = type; + [ResourceLiteral = resource.literal; ] + [InternalLiteral = internal.name; ] + [Alias = alias; ] + [Related = related; ] + [Default = default; ] + [DocName = doc.name; ] + [...]}] + [...] + +Resource definitions start with the +Resource keyword. +For each resource definition, +the name of the resource and whether the resource is an argument, reason, +constraint or subresource is listed. + + + +Argument + +Indicates a standard resource + + + + +Reason + +Indicates a callback resource + + + + +Constraint + +Indicates a constraint resource + + + + +SubResource + +Presently, nothing is done with this value + + + + +The resource definition can be further modified with the following +keywords: + + + +Type + +This indicates the data type of the resource. It must be listed +in the data type definition. + + + + +ResourceLiteral + +This indicates the keyword used in the UIL file to reference the +resource. In Motif, the resource name is the same as the +ResourceLiteral. + + + + +InternalLiteral + +This forces the value of the internal symbol table literal definition +of the resource name. This modifier is only used to get around +symbol table definitions hard coded into the UIL compiler. +It should rarely be used. + + + + +Alias + +This indicates alternate names for the resource +for use in a UIL specification. + + + + +Related + +This is a special purpose field that allows resources that +act as a counter for the current resources to be related to the resource. +UIL automatically sets the value of this related resource to the number of items +in the compiled instance of type resource.name. + + + + +Default + +This indicates the default value of the resource. + + + + +DocName + +This defines an arbitrary string for use in the documentation. +Presently, nothing is done with this value. + + + + +The following example uses the examples from the data type definitions, +control list definitions and class definitions above. + + +Resource + XtbNfirstResource: Argument + { Type = OddNumber; + Default = "XtbOLD_VALUE";}; + XtbNsecondResource: Argument + { Type = NewString; + Default = "XtbNEW_STRING"; }; + XtbNnewResource: Argument + { Type = OddNumber; + Default = "XtbODD_NUMBER"; }; + + + + + +