この付録は、dtksh がサポートするコマンドのリストです。これらのコマンドの多くは、Motif、Xt イントリンシクス、Xlib のコマンドとほとんど同等です。値を返すコマンドには、呼び出しの最初のパラメータである環境変数としての戻り変数が必ずあります。それ以外でも相違点があるコマンドもあります。
次のサブセクションでは、各 dtksh コマンドの形式を示します。一般に、パラメータの順序と型は対応する C プロシージャと同じです。例外については注記します。コマンドの機能およびパラメータに関する詳細は、対応する Xlib、Xt イントリンシクス、Motif プロシージャの標準ドキュメントを参照してください。
コマンド定義では、var、var2、var3 などのパラメータは、値が返される環境変数名をシェル・スクリプトが指定することを示します。variable は戻り値を受け取る環境変数のことです。
ブール値を返すコマンド (if 文の一部として直接使用できます) については、その旨注記します。
[ ] で括られたパラメータはオプションです。
XBell display volume
XClearArea display drawable [optional GC arguments] x y width height exposures
XClearWindow display drawable
XCopyArea display src dest srcX srcY width height destX destY [optional GC arguments]
XDefineCursor display window cursor
XDrawArc display drawable [optional GC arguments] x y width height angle1 angle2
XDrawLine display drawable [optional GC arguments] x1 y1 x2 y2
XDrawLines display drawable [-coordinateMode ] [optional GC arguments] x1 y1 x2 y2 [x3 y3 ...]
coordinateMode は CoordModeOrigin または CoordModePrevious のいずれかです。
XDrawPoint display drawable [optional GC arguments] x y
XDrawPoints display drawable [-coordinateMode] [optional GC arguments] x1 y1 [x2 y2 x3 y3 ... ]
coordinateMode は CoordModeOrigin または CoordModePrevious のいずれかです。
XDrawRectangle display drawable [optional GC arguments] x y width height
XDrawSegments display drawable [optional GC arguments] x1 y1 x2 y2[x3 y3 x4 y4 ...]
XDrawString display drawable [optional GC arguments] x y string
XDrawImageString display drawable [optional GC arguments] x y string
XFillArc display drawable [optional GC arguments] x y width height angle1 angle2
XFillPolygon display drawable [-shape] [-coordinateMode] [optional GC arguments] x1 y1 x2 y2 ...
shape は Complex、Convex、Nonconvex のいずれかであり、coordinateMode は CoordModeOrigin または CoordModePrevious のいずれかです。
XFillRectangle display drawable [optional GC arguments] x y width height
XFlush display
XHeightOfScreen variable screen
XRaiseWindow display window
XRootWindowOfScreen variable screen
XSync display discard
discard は true または false です。
XTextWidth variable fontName string
XTextWidth コマンドは対応する Xlib プロシージャとは異なります。これはコマンドがフォント構造体へのポインタではなくフォント名を取るためです。
XUndefineCursor display window
XWidthOfScreen variable screen
新規ウィジェットを作成するための Xt イントリンシクス・コマンドを使用するときは、新規ウィジェットのウィジェット・クラスを指定してください。ウィジェット (またはガジェット) のクラス名は、Motif が提供する標準クラス名です。たとえば、Motif のプッシュボタン・ウィジェットのクラス名は XmPushButton で、Motif のラベル・ガジェットのクラス名は XmLabelGadget です。
XtAddCallback widgetHandle callbackName ksh-command
callbackName は標準 Motif コールバックまたは標準 Xt コールバックの名前の 1 つで、Xt または Xm の接頭辞を取り除いたものです。たとえば、activateCallback などです。
XtAddEventHandler widgetHandle eventMask nonMaskableFlag ksh-command
eventMask は mask|mask|mask の形式で、mask コンポーネントは X イベント・マスクの標準セットのいずれかであり、nonMaskableFlag は true または false のいずれかです。
XtAddInput variable [-r] fileDescriptor ksh-command
指定したファイル記述子を入力ソースとして X ツールキットで登録します。入力ソースが不要になったときに登録解除してファイル記述子を閉じるのは、シェル・スクリプトの入力ハンドラが行います。
-r オプション (raw モード) を指定すると、入力ソースから使用できるデータを dtksh が自動的に読み取らず、指定した kshell コマンドがすべてのデータを読み取ります。このオプションを指定しない場合は、絶対行 (つまり、エスケープされていない改行文字またはファイルの終わりによって終了している行) が読み取られるか、ファイルの終わりに到達したときにのみ、ksh-command で指定したコマンドが起動されます。テキスト以外のデータを処理するハンドラや、データ行で dtksh を自動的に読み取りたくないハンドラの場合には raw モードが便利です。ファイルの終わりを検出したときに、必要に応じて XtRemoveInput を使用して入力ソースを削除してファイル記述子を閉じるのは、シェル・スクリプトの入力ハンドラです。
どのような場合も、ハンドラが使用するいくつかの環境変数が設定されています。次のような変数があります。
INPUT_LINE
raw モードの場合は空です。そうでない場合は次に処理する行が入ります。
INPUT_EOF
ファイルの終わりに到達すると true に設定されます。そうでない場合は、false です。
INPUT_SOURCE
この入力ソースに関連したファイル記述子です。
INPUT_ID
この入力ハンドラに関連した ID です。XtAddInput() が返します。
XtAddTimeout variable interval ksh-command
XtAddWorkProc variable ksh-command
dtksh では、kshell コマンドは通常 kshell 関数名です。通常の作業プロシージャと同様に、この関数には、作業プロシージャを再び起動するか、作業を完了して自動的に登録解除されることを示す値が返されます。dtksh 関数が 0 を返した場合は、作業プロシージャはまだ登録されています。他の値を返した場合は、作業プロシージャは自動的に登録解除されます。
XtAugmentTranslations widgetHandle translations
XtCreateApplicationShell variable applicationName widgetClass [resource:value ...]
XtCallCallbacks widgetHandle callbackName
callbackName は標準 Motif コールバックまたは標準 Xt コールバックの名前の 1 つで、Xt または Xm の接頭辞を取り除いたものです。たとえば、activateCallback などです。
XtClass variable widgetHandle
渡される先のウィジェット・ハンドルに関連したウィジェット・クラス名を返します。
XtCreateManagedWidget variable widgetName widgetClass parentWidgetHandle [resource:value ...]
XtCreatePopupShell variable widgetName widgetClass parentWidgetHandle [resource:value ...]
XtCreateWidget variable widgetName widgetClass parentWidgetHandle [resource:value ...]
XtDestroyWidget widgetHandle [widgetHandle ...]
XtDisplayOfObject variable widgetHandle
XtGetValues widgetHandle resource: var1 [resource: var2 ...]
XtHasCallbacks variable widgetHandle callbackName
callbackName は標準 Motif コールバックまたは標準 Xt コールバックの名前の 1 つで、Xt または Xm の接頭辞を取り除いたものです。たとえば、activateCallback などです。
variable は CallbackNoList、CallbackHasNone、CallbackHasSome のいずれかに設定されます。
XtInitialize variable shellName applicationClassName applicationName [arguments]
applicationClassName に Dtksh を使用すると、アプリケーションはデフォルトの dtksh app-defaults ファイルを使用します。arguments パラメータは、シェル・スクリプトのユーザが指定する可能性のある任意のコマンド行の引き数のリファレンスに使用されます。これらは通常、「$@」のシェル形式を使用して行われます。
条件文に使用する値を返します。
XtIsManaged widgetHandle
条件文に使用する値を返します。
XtIsSubclass widgetHandle widgetClass
widgetClass はウィジェット・クラス名です。条件文に使用する値を返します。
XtNameToWidget variable referenceWidget name
XtIsRealized widgetHandle
条件文に使用する値を返します。
XtIsSensitive widgetHandle
条件文に使用する値を返します。
XtIsShell widgetHandle
条件文に使用する値を返します。
XtLastTimestampProcessed variable display
XtMainLoop
XtManageChild widgetHandle
XtManageChildren widgetHandle [widgetHandle ...]
XtMapWidget widgetHandle
XtOverrideTranslations widgetHandle translations
XtParent variable widgetHandle
XtPopdown widgetHandle
XtPopup widgetHandle grabType
grabType は GrabNone、GrabNonexclusive、GrabExclusive のいずれかの文字列です。
XtRealizeWidget widgetHandle
XtRemoveAllCallbacks widgetHandle callbackName
callbackName は標準 Motif コールバックまたは標準 Xt コールバックの名前の 1 つで、Xt または Xm の接頭辞を取り除いたものです。たとえば、activateCallback などです。
XtRemoveCallback widgetHandle callbackName ksh-command
callbackName は標準 Motif コールバックまたは標準 Xt コールバックの名前の 1 つで、Xt または Xm の接頭辞を取り除いたものです。たとえば、activateCallback などです。従来の Xt コールバックを指定する場合、コールバックを削除するときは、コールバックを最初に登録したときに指定したのと同じ kshell コマンド文字列を指定してください。
XtRemoveEventHandler widgetHandle eventMask nonMaskableFlag ksh-command
eventMask は mask|mask|mask の形式で、mask コンポーネントは X イベント・マスクの標準セットのいずれかです。nonMaskableFlag で指定する ButtonPressMask は true または false のいずれかです。
従来の Xt イベント・ハンドラで true の場合、イベント・ハンドラを削除するときは、イベント・ハンドラを最初に登録したときに指定したのと同じ eventMask および nonMaskableFlag の設定と、kshell コマンド文字列を指定してください。
XtRemoveInput inputId
inputId は、XtAddInput コマンドを使用して代替入力ソースを登録したときに、指定した環境変数に返されるハンドルです。
XtRemoveTimeOut timeoutId
timeoutId は、XtAddTimeOut コマンドを使用してタイムアウトを登録したときに、指定した環境変数に返されるハンドルです。
XtRemoveWorkProc workprocID
workprocId は、XtAddWorkProc コマンドを使用して作業プロシージャを登録したときに、指定した環境変数に返されるハンドルです。
XtScreen variable widgetHandle
XtSetSensitive widgetHandle state
state は true または false のいずれかです。
XtSetValues widgetHandle resource:value [resource: value ...]
XtUninstallTranslations widgetHandle
XtUnmanageChild widgetHandle
XtUnmanageChildren widgetHandle [widgetHandle ...]
XtUnmapWidget widgetHandle
XtUnrealizeWidget widgetHandle
XtWindow variable widgetHandle
XmAddWMProtocolCallback widgetHandle protocolAtom ksh-command
protocolAtom は通常、XmInternAtom コマンドを使用して獲得します。
XmAddWMProtocols widgetHandle protocolAtom[protocolAtom ...]
protocolAtom は通常、XmInternAtom コマンドを使用して獲得します。
XmCommandAppendValue widgetHandle string
XmCommandError widgetHandle errorString
XmCommandGetChild variable widgetHandle childType
childType は、DIALOG_COMMAND_TEXT、DIALOG_PROMPT_LABEL、 DIALOG_HISTORY_LIST、DIALOG_WORK_AREA のいずれかの文字列です。
XmCommandSetValue widgetHandle commandString
XmCreateArrowButton variable parentWidgetHandle name [resource:value...]
XmCreateArrowButtonGadget variable parentWidgetHandle name [resource:value ...]
XmCreateBulletinBoard variable parentWidgetHandle name [resource:value ...]
XmCreateBulletinBoardDialog variable parentWidgetHandle name [resource:value ...]
XmCreateCascadeButton variable parentWidgetHandle name [resource:value ...]
XmCreateCascadeButtonGadget variable parentWidgetHandle name [resource:value ...]
XmCreateCommand variable parentWidgetHandle name[resource:value ...]
XmCreateDialogShell variable parentWidgetHandle name [resource:value ...]
XmCreateDrawingArea variableparent WidgetHandle name [resource:value ...]
XmCreateDrawnButton variable parentWidgetHandle name [resource:value ...]
XmCreateErrorDialog variable parentWidgetHandle name [resource:value ...]
XmCreateFileSelectionBox variable parentWidgetHandle name [resource:value ...]
XmCreateFileSelectionDialog variable parentWidgetHandle name [resource:value ...]
XmCreateForm variable parentWidgetHandle name[resource:value ...]
XmCreateFormDialog variable parentWidgetHandle name[resource:value ...]
XmCreateFrame variable parentWidgetHandle name[resource:value ...]
XmCreateInformationDialog variable parentWidgetHandle name [resource:value ...]
XmCreateLabel variable parentWidgetHandle name[resource:value ...]
XmCreateLabelGadget variable parentWidgetHandle name [resource:value ...]
XmCreateList variable parentWidgetHandle name[resource:value ...]
XmCreateMainWindow variable parentWidgetHandle name [resource:value ...]
XmCreateMenuBar variable parentWidgetHandle name[resource:value ...]
XmCreateMenuShell variable parentWidgetHandle name[resource:value ...]
XmCreateMessageBox variable parentWidgetHandle name[resource:value ...]
XmCreateMessageDialog variable parentWidgetHandle name [resource:value ...]
XmCreateOptionMenu variable parentWidgetHandle name[resource:value ...]
XmCreatePanedWindow variable parentWidgetHandle name [resource:value ...]
XmCreatePopupMenu variable parentWidgetHandle name[resource:value ...]
XmCreatePromptDialog variable parentWidgetHandle name [resource:value ...]
XmCreatePulldownMenu variable parentWidgetHandle name [resource:value ...]
XmCreatePushButton variable parentWidgetHandle name [resource:value ...]
XmCreatePushButtonGadget variable parentWidgetHandle name [resource:value ...]
XmCreateQuestionDialog variable parentWidgetHandle name [resource:value ...]
XmCreateRadioBox variable parentWidgetHandle name[resource:value ...]
XmCreateRowColumn variable parentWidgetHandle name[resource:value ...]
XmCreateScale variable parentWidgetHandle name[resource:value ...]
XmCreateScrollBar variable parentWidgetHandle name[resource:value ...]
XmCreateScrolledList variable parentWidgetHandle name [resource:value ...]
XmCreateScrolledText variable parentWidgetHandle name [resource:value ...]
XmCreateScrolledWindow variable parentWidgetHandle name [resource:value ...]
XmCreateSelectionBox variable parentWidgetHandle name [resource:value ...]
XmCreateSelectionDialog variable parentWidgetHandle name [resource:value ...]
XmCreateSeparator variable parentWidgetHandle name[resource:value ...]
XmCreateSeparatorGadget variable parentWidgetHandle name [resource:value ...]
XmCreateText variable parentWidgetHandle name[resource:value ...]
XmCreateTextField variable parentWidgetHandle name[resource:value...]
XmCreateToggleButton variable parentWidgetHandle name [resource:value ...]
XmCreateToggleButtonGadget variable parentWidgetHandle name [resource:value ...]
XmCreateWarningDialog variable parentWidgetHandle name [resource:value ...]
XmCreateWorkArea variable parentWidgetHandle name[resource:value ...]
XmCreateWorkingDialog variable parentWidgetHandle name [resource:value ...]
XmFileSelectionDoSearch widgetHandle directoryMask
XmFileSelectionBoxGetChild variable widgetHandle childType
childType は、DIALOG_APPLY_BUTTON、DIALOG_CANCEL_BUTTON、 DIALOG_DEFAULT_BUTTON、DIALOG_DIR_LIST、DIALOG_DIR_LIST_LABEL、 DIALOG_FILTER_LABEL、DIALOG_FILTER_TEXT、DIALOG_HELP_BUTTON、 DIALOG_LIST、DIALOG_LIST_LABEL、DIALOG_OK_BUTTON、DIALOG_SEPARATOR、 DIALOG_SELECTION_LABEL、DIALOG_TEXT、DIALOG_WORK_AREA のいずれかの文字列です。
XmGetAtomName variable display atom
XmGetColors widgetHandle background variable var2 var3 var4
XmGetColors コマンドは、画面ポインタとカラーマップではなく widgetHandle を取るという点で C プロシージャと異なります。
XmGetFocusWidget variable widgetHandle
XmGetPostedFromWidget variable widgetHandle
XmGetTabGroup variable widgetHandle
XmGetTearOffControl variable widgetHandle
XmGetVisibility variable widgetHandle
XmInternAtom variable display atomString onlyIfExistsFlag
onlyIfExistsFlag は true または false のいずれかに設定されます。
XmIsTraversable widgetHandle
条件文で使用する値を返します。
XmListAddItem widgetHandle position itemString
XmListAddItem コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListAddItems widgetHandle position itemString[itemString ...]
XmListAddItems コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListAddItemsUnselected widgetHandle position itemString [itemString ...]
XmListAddItemsUnselected コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListAddItemUnselected widgetHandle position itemString
XmListAddItemUnselected コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListDeleteAllItems widgetHandle
XmListDeleteItem widgetHandle itemString
XmListDeleteItems widgetHandle itemString[itemString ...]
XmListDeleteItemsPos widgetHandle itemCount position
XmListDeletePos widgetHandle position
XmListDeletePositions widgetHandle position[position ...]
XmListDeselectAllItems widgetHandle
XmListDeselectItem widgetHandle itemString
XmListDeselectPos widgetHandle position
XmListGetSelectedPos variable widgetHandle
カンマで区切られた variable の索引のリストを返します。条件文で使用する値を返します。
XmListGetKbdItemPos variable widgetHandle
XmListGetMatchPos variable widgetHandle itemString
カンマで区切られた variable の索引のリストを返します。条件文で使用する値を返します。
XmListItemExists widgetHandle itemString
条件文で使用する値を返します。
XmListItemPos variable widgetHandle itemString
XmListPosSelected widgetHandle position
条件文で使用する値を返します。
XmListPosToBounds widgetHandle position variable var2 var3 vari4
条件文で使用する値を返します。
XmListReplaceItemsPos widgetHandle position itemString [itemString ...]
XmListReplaceItemsPos コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListReplaceItemsPosUnselected widgetHandle position itemString [itemString ...]
XmListReplaceItemsPosUnselected コマンドのパラメータの順序は、対応する C プログラミングのパラメータの順序とは同じではありません。
XmListSelectItem widgetHandle itemString notifyFlag
notifyFlag は true または false のいずれかに設定されます。
XmListSelectPos widgetHandle position notifyFlag
notifyFlag は true または false のいずれかに設定されます。
XmListSetAddMode widgetHandle state
state は true または false のいずれかに設定されます。
XmListSetBottomItem widgetHandle itemString
XmListSetBottomPos widgetHandle position
XmListSetHorizPos widgetHandle position
XmListSetItem widgetHandle itemString
XmListSetKbdItemPos widgetHandle position
条件文で使用する値を返します。
XmListSetPos widgetHandle position
XmListUpdateSelectedList widgetHandle
XmMainWindowSep1 variable widgetHandle
XmMainWindowSep2 variable widgetHandle
XmMainWindowSep3 variable widgetHandle
XmMainWindowSetAreas widgetHandle menuWidgetHandle commandWidgetHandle horizontalScrollbarWidgetHandle verticalScrollbarWidgetHandle workRegionWidgetHandle
XmMenuPosition widgetHandle eventHandle
eventHandle は X イベントに対応します。これは通常、環境変数 CB_CALL_DATA.EVENT、EH_EVENT、TRANSLATION_EVENT のいずれかにアクセスすると獲得できます。
XmMessageBoxGetChild variable widgetHandle childType
childType は、DIALOG_CANCEL_BUTTON、DIALOG_DEFAULT_BUTTON、 DIALOG_HELP_BUTTON、DIALOG_MESSAGE_LABEL、DIALOG_OK_BUTTON、 DIALOG_SEPARATOR、DIALOG_SYMBOL_LABEL のいずれかの文字列です。
XmOptionButtonGadget variable widgetHandle
XmOptionLabelGadget variable widgetHandle
XmProcessTraversal widgetHandle direction
direction は、TRAVERSE_CURRENT、TRAVERSE_DOWN、TRAVERSE_HOME、 TRAVERSE_LEFT、TRAVERSE_NEXT、TRAVERSE_NEXT_TAB_GROUP、 TRAVERSE_PREV、TRAVERSE_PREV_TAB_GROUP、TRAVERSE_RIGHT、 TRAVERSE_UP のいずれかの文字列です。
条件文で使用する値を返します。
XmRemoveWMProtocolCallback widgetHandle protocolAtom ksh-command
protocolAtom は通常、XmInternAtom コマンドを使用して獲得されます。
従来のウィンドウ・マネージャ・コールバックを指定する場合、コールバックを削除するときは、コールバックを最初に登録したときに指定したのと同じ kshell コマンド文字列を指定してください。
XmRemoveWMProtocols widgetHandle protocolAtom[protocolAtom ...]
protocolAtom は通常、XmInternAtom コマンドを使用して獲得されます。
XmScaleGetValue widgetHandle variable
XmScaleSetValue widgetHandle value
XmScrollBarGetValues widgetHandle variable var2 var3 var4
XmScrollBarSetValues widgetHandle value sliderSize increment pageIncrement notifyFlag
notifyFlag は true または false のいずれかに設定されます。
XmScrollVisible widgetHandle widgetHandle leftRightMargin topBottomMargin
XmSelectionBoxGetChild variable widgetHandle childType
childType は、DIALOG_CANCEL_BUTTON、DIALOG_DEFAULT_BUTTON、 DIALOG_HELP_BUTTON、DIALOG_APPLY_BUTTON、DIALOG_LIST、 DIALOG_LIST_LABEL、DIALOG_OK_BUTTON、DIALOG_SELECTION_LABEL、 DIALOG_SEPARATOR、DIALOG_TEXT、DIALOG_WORK_AREA のいずれかの文字列です。
XmTextClearSelection widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
XmTextCopy widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
条件文で使用する値を返します。
XmTextCut widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
条件文で使用する値を返します。
XmTextDisableRedisplay widgetHandle
XmTextEnableDisplay widgetHandle
XmTextFindString widgetHandle startPosition string direction variable
direction は TEXT_FORWARD または TEXT_BACKWARD のいずれかの文字列です。
条件文で使用する値を返します。
XmTextGetBaseline variable widgetHandle
XmTextGetEditable widgetHandle
条件文で使用する値を返します。
XmTextGetInsertionPosition variable widgetHandle
XmTextGetLastPosition variable widgetHandle
XmTextGetMaxLength variable widgetHandle
XmTextGetSelection variable widgetHandle
XmTextGetSelectionPosition widgetHandle variable var2
条件文で使用する値を返します。
XmTextGetString variable widgetHandle
XmTextGetTopCharacter variable widgetHandle
XmTextInsert widgetHandle position string
XmTextPaste widgetHandle
条件文で使用する値を返します。
XmTextPosToXY widgetHandle position variable var2
条件文で使用する値を返します。
XmTextRemove widgetHandle
条件文で使用する値を返します。
XmTextReplace widgetHandle fromPosition toPositionstring
XmTextScroll widgetHandle lines
XmTextSetAddMode widgetHandle state
state は true または false のいずれかに設定されます。
XmTextSetEditable widgetHandle editableFlag
editableFlag は true または false のいずれかに設定されます。
XmTextSetHighlight widgetHandle leftPosition rightPosition mode
mode は、HIGHLIGHT_NORMAL、HIGHLIGHT_SELECTED、 HIGHLIGHT_SECONDARY_SELECTED のいずれかの文字列です。
XmTextSetInsertionPosition widgetHandle position
XmTextSetMaxLength widgetHandle maxLength
XmTextSetSelection widgetHandle firstPosition lastPosition time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
XmTextSetString widgetHandle string
XmTextSetTopCharacter widgetHandle topCharacterPosition
XmTextShowPosition widgetHandle position
XmTextXYToPos variable widgetHandle x y
XmTextFieldClearSelection widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
XmTextFieldGetBaseline variable widgetHandle
XmTextFieldGetEditable widgetHandle
条件文で使用する値を返します。
XmTextFieldGetInsertionPosition variable widgetHandle
XmTextFieldGetLastPosition variable widgetHandle
XmTextFieldGetMaxLength variable widgetHandle
XmTextFieldGetSelection variable widgetHandle
XmTextFieldGetSelectionPosition widgetHandle variable var2
条件文で使用する値を返します。
XmTextFieldGetString variable widgetHandle
XmTextFieldInsert widgetHandle position string
XmTextFieldPosToXY widgetHandle position variable var2
条件文で使用する値を返します。
XmTextFieldRemove widgetHandle
条件文で使用する値を返します。
XmTextFieldReplace widgetHandle fromPosition toPosition string
XmTextFieldSetEditable widgetHandle editableFlag
editableFlag は true または false のいずれかに設定されます。
XmTextFieldSetHighlight widgetHandle leftPosition rightPosition mode
mode は HIGHLIGHT_NORMAL、HIGHLIGHT_SELECTED、 HIGHLIGHT_SECONDARY_SELECTED のいずれかの文字列です。
XmTextFieldSetInsertionPosition widgetHandle position
XmTextFieldSetMaxLength widgetHandle maxLength
XmTextFieldSetSelection widgetHandle firstPosition lastPosition time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
XmTextFieldSetString widgetHandle string
XmTextFieldShowPosition widgetHandle position
XmTextFieldXYToPos variable widgetHandle x y
XmTextFieldCopy widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
条件文で使用する値を返します。
XmTextFieldCut widgetHandle time
time は通常、X イベント内から獲得され、XtLastTimestampProcessed コマンドの呼び出しによって照会されます。
条件文で使用する値を返します。
XmTextFieldPaste widgetHandle
条件文で使用する値を返します。
XmTextFieldSetAddMode widgetHandle state
state は true または false のいずれかに設定されます。
XmToggleButtonGadgetGetState widgetHandle
条件文で使用する値を返します。
XmToggleButtonGadgetSetState widgetHandle state notifyFlag
state は true または false のいずれかに設定され、notifyFlag は true または false のいずれかに設定されます。
XmToggleButtonGetState widgetHandle
条件文で使用する値を返します。
XmToggleButtonSetState widgetHandle state notifyFlag
state は true または false のいずれかに設定され、notifyFlag は true または false のいずれかに設定されます。
XmUpdateDisplay widgetHandle
DtCreateQuickHelpDialog variable parentWidgetHandle name[resource:value ...]
DtCreateHelpDialog variable parentWidgetHandle name [resource:value...]
DtHelpQuickDialogGetChild variable widgetHandle childType
childType は、HELP_QUICK_OK_BUTTON、HELP_QUICK_PRINT_BUTTON、 HELP_QUICK_HELP_BUTTON、HELP_QUICK_SEPARATOR、 HELP_QUICK_MORE_BUTTON、HELP_QUICK_BACK_BUTTON のいずれかの文字列です。
DtHelpReturnSelectedWidgetId variable widgetHandle var2
variable は、HELP_SELECT_VALID、HELP_SELET_INVALID、 HELP_SELECT_ABORT、HELP_SELECT_ERROR のいずれかの文字列です。var2 は選択したウィジェットの widgetHandle に設定されます。
DtHelpSetCatalogName catalogName
catopen variable catalogName
指定したメッセージ・カタログを開き、variable で指定した環境変数にカタログ ID を返します。メッセージ・カタログに指定されたファイル記述子を閉じることをシェル・スクリプトが必要としている場合は、catclose コマンドを使用してカタログ ID を閉じてください。
catgets variable catalogId setNumber messageNumber defaultMessageString
要求したメッセージ文字列を catalogId パラメータで指定したメッセージ・カタログから取り出します。メッセージ文字列を取り出せない場合は、デフォルトのメッセージ文字列が返されます。いずれの場合も返されたメッセージ文字列は variable で指定した環境変数に入れられます。
catclose catalogId
指定した catalogId に関連したメッセージ・カタログを閉じます。
DtSessionRestorePath widgetHandle variable sessionFile
(パス情報を含まない) セッション・ファイルのファイル名を指定します。このコマンドは variable で指定する環境変数にセッション・ファイルの絶対パスを返します。
正常終了の場合は 0、異常終了の場合は 1 を返します。
DtSessionSavePath widgetHandle variable var2
variable で指定する環境変数にセッション・ファイルの絶対パス名を返します。(パス情報を含まない) セッション・ファイルのファイル名部分は var2 で指定される環境変数に返されます。
正常終了の場合は 0、異常終了の場合は 1 を返します。
DtShellIsIconified widgetHandle
シェル・スクリプトがシェル・ウィンドウのアイコン化状態を照会できるようにします。正常終了の場合は 0、異常終了の場合は 1 を返します。
DtSetStartupCommand widgetHandle commandString
セッション管理プロセスの部分が、ユーザがセッションを次に再開するときのアプリケーションの再起動方法をセッション・マネージャに通知します。このコマンドは、指定したコマンド文字列をセッション・マネージャに渡します。ウィジェット・ハンドルはアプリケーション・シェルです。
DtSetIconifyHint widgetHandle iconifyHint
iconifyHint は true または false のいずれかに設定されます。
最初のアイコン化状態をシェル・ウィンドウが設定できるようにします。このコマンドは、ウィジェットに指定したウィンドウが認識されているが表示されていない場合のみ実行できます。
DtWsmAddCurrentWorkspaceCallback variable widgetHandle ksh-command
ユーザがワークスペースを変更するたびに、指定した kshell コマンドを評価します。このコールバックに指定したハンドルは variable で指定した環境変数に返されます。widgetHandle で指定するウィジェットはシェル・ウィジェットです。
DtWsmRemoveWorkspaceCallback callbackHandle
ワークスペース通知コールバックを削除します。削除するときは、DtWsmAddCurrentWorkspaceCallback でコールバックを登録したときに返されたコールバック・ハンドルを callbackHandle に指定してください。
DtWsmGetCurrentWorkspace display rootWindow variable
ユーザの現在のワークスペースを示す X アトムを variable で指定した環境変数に返します。XmGetAtomName コマンドを使用して X アトムを文字列表現にマップしてください。
DtWsmSetCurrentWorkspace widgetHandle workspaceNameAtom
ユーザの現在のワークスペースを workspaceNameAtom で指定したワークスペースに変更します。
正常終了の場合は 0、異常終了の場合は 1 を返します。
DtWsmGetWorkspaceList display rootWindow variable
カンマで区切られた X アトムの文字列を返します。ユーザのために定義された現在のワークスペースのセットを variable で指定した環境変数に返します。
正常終了の場合は 0、異常終了の場合は 1 を返します。
DtWsmGetWorkspacesOccupied display window variable
カンマで区切られた X アトムの文字列を返します。window で指定したシェル・ウィンドウで占められた現在のワークスペースのセットを variable で指定した環境変数に返します。
正常終了の場合は 0、異常終了の場合は 1 を返します。
DtWsmSetWorkspacesOccupied display window workspaceList
window で指定したシェル・ウィンドウを workspaceList で指定したワークスペースのセットに移動します。workspaceList はカンマで区切られた X アトムのリストです。
DtWsmAddWorkspaceFunctions display window
ウィンドウ・マネージャ・メニューに、ウィンドウを他のワークスペースに移動させるのに使用する関数を取り込ませます。このコマンドは、ウィンドウが描画状態である場合のみ実行できます。
DtWsmRemoveWorkspaceFunctions display window
ウィンドウ・マネージャ・メニューに、ウィンドウを他のワークスペースに移動させるのに使用する関数を表示しないようにします。こうするとウィンドウが他のワークスペースに移動しません。このコマンドは、ウィンドウが描画状態である場合のみ実行できます。
DtWsmOccupyAllWorkspaces display window
ウィンドウが、作成した新規ワークスペースも含めてすべてのワークスペースを占有するよう要求します。
DtWsmGetCurrentBackdropWindows display rootWindow variable
コンマで区切られたウィンドウ ID の文字列を返します。この ID は一連のルート・バックドロップ・ウィンドウを示します。
この節で説明するコマンドは、アクション・データベースの読み込み、データベースで定義されたアクションに関する情報の照会、アクションの起動要求を行うためのツールを提供します。
DtDbLoad
アクションおよびデータ型データベースを読み込みます。複数回呼び出すと、古いデータベースは新しいデータベースを読み込む前に解放されます。このコマンドは、他の libDt アクション・コマンドまたは libDt データ型作成コマンドを起動する前に起動してください。シェル・スクリプトも DtDbReloadNotify コマンドを使用するので、新しいデータベースが読み込まれるとシェル・スクリプトに通知されます。
DtDbReloadNotify ksh-command
アクションまたはデータ型データベースの再読み込みが必要になったら必ず通知するよう要求します。指定した kshell コマンドは、通知を受け取ると実行されます。通常 kshell コマンドは、DtDbLoad コマンドの呼び出しを含みます。
DtActionExists actionName
actionName パラメータで指定した名前のデータベースにアクションが存在するかどうかをテストします。条件文に使用する値を返します。
DtActionLabel variable actionName
指定したアクションに関連したローカライズ可能な LABEL 属性を返します。アクションが存在しない場合は、空の文字列が返されます。
DtActionDescription variable actionName
指定したアクションに関連した DESCRIPTION 属性を返します。アクションが定義されていないか、DESCRIPTION 属性が指定されていない場合は、空の文字列が返されます。
DtLoadDataTypes
データ型データベースを読み込みます。他のデータ型作成コマンドより先に起動されなければなりません。
DtDtsFileToDataType variable filePath
filePath 引き数で指定したファイルに関連したデータ型の名前を variable 引き数に返します。ファイルがない場合、variable 引き数には空の文字列が設定されます。
DtDtsFileToAttributeValue variable filePath attrName
filePath で指定したファイルに関連したデータ型のための attrName で指定した属性の値を表す文字列を返します。属性が定義されていない場合、またはファイルがない場合は、variable 引き数には空の文字列が設定されます。
DtDtsFileToAttributeList variable filePath
filePath で指定したファイルに関連したデータ型に定義された属性名をスペースで区切られたリストで返します。シェル・スクリプトが属性の個々の値を照会するには、DtDtsFileToAttributeValue コマンドを使用します。ファイルがない場合、variable 引き数には空の文字列が設定されます。このコマンドは定義された属性名だけを返して値は返さないという点で、対応する C プログラミングのコマンドとは異なります。
DtDtsDataTypeToAttributeValue variable dataType attrName optName
dataType で指定したデータ型の attrName で指定した属性の値を表す文字列を返します。属性が定義されていない場合、または指定したデータ型が存在しない場合は、variable 引き数には空の文字列が設定されます。
DtDtsDataTypeToAttributeList variable dataType optName
dataType で指定したデータ型に定義された属性名をスペースで区切られたリストで返します。シェル・スクリプトが属性の個々の値を照会するには、DtDtsDataTypeToAttributeValue コマンドを使用します。データ型が定義されていない場合は、variable 引き数には空の文字列が設定されます。このコマンドは定義された属性名だけを返して値は返さないという点で、対応する C プログラミングのコマンドとは異なります。
DtDtsFindAttribute variable name value
name 引き数に指定した属性で value 引き数に指定した値を持つデータ型の名前をスペースで区切られたリストで返します。エラーが生じた場合、variable 引き数には空の文字列が設定されます。
DtDtsDataTypeNames variable
データ型データベースに現在定義されているすべてのデータ型をスペースで区切られたリストで返します。エラーが生じた場合、variable 引き数には空の文字列が設定されます。
DtDtsSetDataType variable filePath dataType override
指定したディレクトリのデータ型を設定します。variable 引き数にはディレクトリに保存されたデータ型が設定されます。
DtDtsDataTypeIsAction dataType
特定のデータ型がアクション・エントリを示すかどうかを判別します。条件文で使用する値を返します。
DtGetHourGlassCursor variable display
標準 Dt 時計表示カーソルに関連した X カーソル ID を返します。
DtTurnOnHourGlass widgetHandle
指定したウィジェットの標準 Dt 時計表示カーソルをオンにします。
DtTurnOffHourGlass widgetHandle
指定したウィジェットの標準 Dt 時計表示カーソルをオフにします。
次に示すコマンドは、シェル・スクリプトがデスクトップ・サービス・プロトコルの参入に必要なデスクトップ・サービス・メッセージ・セットの最小サブセットを実行します。ほとんどの ToolTalk コマンドは対応する C プログラミング・コールとわずかに異なっています。通常はポインタを返す ToolTalk コマンドでは、C アプリケーションが tt_ptr_error() 関数を呼び出すことによってそのポインタを有効にします。この関数呼び出しはポインタが有効であるかどうかを示す Tt_status 値を返します。有効でない場合は、その理由を示します。kshell コードの設計上の理由から、シェル・スクリプトが見る文字列ポインタは、通常は、基本の C コードが返す文字列ポインタと同じではありません。シェルのプログラミング中は、重要な情報が文字列ポインタではなく文字列値で示されるため、これは問題にはなりません。
シェル・スクリプトがポインタのステータスを獲得できるようにするため、通常はポインタを返すコマンドは、自動的にそのポインタに関連する Tt_status 値も返します。これによってシェル・スクリプトは、元のポインタの有効性を検査するために呼び出しを追加する必要がなくなります。ポインタ・エラーが生じた場合は、dtksh はポインタ値として空の文字列を返し、Tt_status コードを設定します。
Tt_status 値は status 引き数に返されます。Tt_status 値はエラーを示す文字列で、次のいずれかの値になります。
一部のコマンドはパラメータとしてメッセージ・スコープを取ります。スコープは発信メッセージを受信する可能性のあるクライアントを示します。これらのコマンドでは、scope パラメータが次のいずれかの値に設定されます。
TT_file_netfile variable status filename
指定した filename (ローカル・ホストで有効と見なされるファイル名) を、対応する netfilename 書式に変換します。netfilename はネットワーク上の他のホストに渡され、他のホストに関連したパスになるように tt_netfile_file コマンドによって変換されます。
tt_netfile_file variable status netfilename
指定した netfilename をローカル・ホストで有効なパス名に変換します。
tt_host_file_netfile variable status host filename
指定したファイル (指定したホストに存在すると見なされる) を、対応する netfilename 書式に変換します。
tt_host_netfile_file variable status host netfilename
指定した netfilename を指定したホストで有効なパスに変換します。
ttdt_open variable status var2 toolname vendor version sendStarted
ToolTalk 通信エンドポイントを開きます。この接続に関連した procID を variable 引き数に返します。この接続に関連したファイル記述子は var2 に返します。ファイル記述子は代替 Xt 入力ハンドラを登録するのに使用します。sendStarted 引き数は、true が設定されると Started メッセージが自動的に送信されます。
ttdt_open によって返される任意の procID は埋め込みスペースを含みます。kshell が procID を複数のパラメータである (埋め込みスペースを伴う 1 つのパラメータではなく) と解釈しないように、procID を含む環境変数は次に示すように常に二重引用符で囲んでください。
ttdt_close STATUS "$PROC_ID" "" True
tttk_Xt_input_handler procID source id
ToolTalk メッセージを受信および処理するために、シェル・スクリプトは ttdt_open の呼び出しによって返されるファイル記述子に対して Xt 入力ハンドラを登録しなければなりません。Xt 入力ハンドラは XtAddInput コマンドを使用して登録しますが、raw 入力ハンドラとして登録してください。シェル・スクリプトが登録した入力ハンドラは tttk_Xt_input_handler を呼び出してメッセージを受信および処理します。次のコード・ブロックで実行方法を示します。
ttdt_open PROC_ID STATUS FID "Tool" "HP" "1.0" True XtAddInput INPUT_ID -r $FID "ProcessTTInput ¥"$PROC_ID¥"" ProcessTTInput() { tttk_Xt_input_handler $1 $INPUT_SOURCE $INPUT_ID }
代替 Xt 入力ハンドラの詳細は、XtAddInput コマンドの説明を参照してください。
procID 環境変数を示すには、必ず前後に " (バックスラッシュと二重引用符) を付けてください。procID 環境変数の値は埋め込みスペースを含んでいて、誤って解釈される可能性があるためです。
ttdt_close status procID newProcId sendStopped
指定した通信接続を閉じ、sendStopped 引き数に true が設定されているとオプションで Stopped 通知を送信します。
ttdt_open の呼び出しによって返される procID には埋め込みスペースが入っているので、procID 環境変数を示すものは次のように二重引用符で囲んでください。
ttdt_close STATUS "$PROC_ID" "$NEW_PROC_ID" False
ttdt_session_join variable status sessId shellWidgetHandle join
多くの標準デスクトップ・メッセージ・インタフェースのパターン・コールバックとデフォルト・コールバックを登録することによって、適切なデスクトップとして sessID 引き数で指定したセッションを結合します。sessID 引き数が値を指定しない (つまり空の文字列である) 場合は、デフォルト・セッションが結合されます。shellWidgetHandle 引き数がウィジェット・ハンドルを指定した (つまり空の文字列ではない) 場合は、mappedWhenManaged applicationShellWidget になります。join 引き数はブール値で、true または false が設定されます。このコマンドは variable 引き数に隠された pattern ハンドルを返します。このハンドルが必要なくなったときは、ttdt_session_quit コマンドで破棄できます。
ttdt_session_quit status sessId sessPatterns quit
sessPatterns 引き数で指定されるメッセージ・パターンを破棄します。quit 引き数に true が設定されている場合は、sessId 引き数は表示セッションを終了します。sessId が空の場合はデフォルト・セッションを終了します。
ttdt_file_join variable status pathName scope join ksh-command
削除、変更、復帰、移動、保存されたメッセージの配信対象を、指定したスコープの指定したファイルに登録します。隠されたパターン・ハンドルが variable 引き数に返されます。指定したファイルのメッセージを監視する必要がなくなったときは、ttdt_file_quit コマンドで破棄できます。
要求した ksh-command は、指定したファイルがメッセージを受信すると常に評価されます。この kshell コマンドを評価すると、次に示す環境変数が定義され、受信したメッセージに関する追加情報が提供されます。
DT_TT_MSG
着信メッセージに隠されたハンドルが入っています。
DT_TT_OP
実行しなければならないオペレーションを示す文字列が入っています。文字列は、 TTDT_DELETED、TTDT_MODIFIED、TTDT_REVERTED、TTDT_MOVED、 TTDT_SAVED のいずれかです。
DT_TT_PATHNAME
メッセージが属するファイルのパス名が入っています。
DT_TT_SAME_EUID_EGID
このプロセスと同じ有効ユーザ ID (euid) および有効グループ ID (egid) で動作するアプリケーションによってメッセージが送信された場合は true に設定されます。
DT_TT_SAME_PROCID
(ttdt_open が返すのと) 同じ procID を持つアプリケーションによってメッセージが送信された場合は、true に設定されます。
コールバックが完了すると、渡される先のメッセージが「消費」(応答、破棄、拒否のいずれか) されたかどうかが必ず示されます。コールバックがメッセージを返す場合 (DT_TT_MSG 環境変数に渡されます)、メッセージは消費されていないものと見なされます。メッセージが消費された場合は、コールバックは 0、あるいは tt_error_pointer コマンドが返す値の 1 つを返します。コールバックは値を次のように返します。
return $DT_TT_MSG (or) return 0
ttdt_file_quit status patterns quit
patterns 引き数で指定するメッセージ・パターンを破棄し、quit 引き数に true が設定されている場合は、ttdt_file_joinコマンドに渡されたパス名の配信先を登録解除します。patterns 引き数は、ttdt_file_join コマンドの呼び出しによって返される値です。
ttdt_file_event status op patterns send
ファイルに関するイベントを通知する ToolTalk 通知を作成し、オプションで送信します。ファイルは、patterns の作成時に ttdt_file_join コマンドに渡されたパス名によって示されます。op 引き数は、指定したファイルに通知する内容を示すもので、TTDT_MODIFIED、TTDT_SAVED、TTDT_REVERTED のいずれかです。op 引き数に TTDT_MODIFIED が設定されている場合、このコマンドはGet_Modified、Save、Revertの各メッセージの処理を patterns の作成時に指定されたスコープに登録します。op 引き数に TTDT_SAVED または TTDT_REVERTED が設定されている場合は、このファイルの Get_Modified、Save、Revert の各メッセージの処理を登録解除します。send 引き数に true が設定されている場合は、表示されているメッセージが送信されます。
ttdt_Get_Modified pathName scope timeout
Get_Modified 要求を指定したスコープに送信し、応答があるか、指定したタイムアウト (ミリ秒単位) が経過するのを待ちます。Get_Modified 要求は、他の ToolTalk クライアントに、固定表示しようとして保留している pathname を変更したかどうかをたずねます。条件文で使用する値を返します。指定したタイムアウト内に肯定応答を受信した場合は値 true が返され、そうでない場合は false が返されます。
ttdt_Save status pathName scope timeout
Save 要求を指定したスコープに送信し、応答があるか、指定したタイムアウト (ミリ秒単位) が経過するのを待ちます。Save 要求は、処理中の ToolTalk クライアントに、pathName 引き数で指定したファイルで保留している変更を保存するかどうかをたずねます。指定したタイムアウト内に肯定応答を受信した場合はステータス TT_OK が返され、そうでない場合は標準の Tt_status エラー値のうちの 1 つが返されます。
ttdt_Revert status pathName scope timeout
Revert 要求を指定したスコープに送信し、応答があるか、指定したタイムアウト (ミリ秒単位) が経過するのを待ちます。Revert 要求は、処理中の ToolTalk クライアントに、pathName 引き数で指定したファイルで保留している変更を破棄するかどうかをたずねます。指定したタイムアウト内に肯定応答を受信した場合はステータス TT_OK が返され、そうでない場合は標準の Tt_status エラー値のうちの 1 つが返されます。
次のコマンドは通常、ttdt_file_join コマンドで登録されたコールバックが使用します。メッセージの消費および破棄を行う機能を提供します。メッセージは、拒否されるか、破棄されるか、応答されることによって消費されます。tt_error_pointer はコールバックが使用して、エラー条件を示す戻りポインタを獲得します。
tt_error_pointer variable ttStatus
無効なポインタを表すために ToolTalk が使用する「マジック値」を返します。マジック値は ttStatus 値が渡される先に依存して返されます。任意の有効な Tt_status 値を指定できます。
tttk_message_destroy status msg
msg 引き数が示すメッセージに格納されている任意のパターンを破棄し、メッセージを破棄します。
tttk_message_reject status msg msgStatus msgStatusString destroy
ステータスおよびステータス文字列を指定した要求メッセージに設定し、メッセージを拒否します。destroy 引き数に true が設定されている場合は、渡されるメッセージを破棄します。このコマンドは、ttdt_file_join コマンドで指定されたコールバックがメッセージを消費するための 1 つの方法です。通常、安全にメッセージを破棄するには、メッセージを拒否した後で tttk_message_destroy を使用してください。
tttk_message_fail status msg msgStatus msgStatusString destroy
ステータスおよびステータス文字列を指定した要求メッセージに設定し、メッセージを破棄します。destroy 引き数に true が設定されている場合は渡されるメッセージを破棄します。このコマンドは、ttdt_file_join コマンドで指定されたコールバックがメッセージを消費するための 1 つの方法です。通常、安全にメッセージを破棄するには、メッセージを拒否した後で tttk_message_destroy を使用してください。
tt_message_reply status msg
シェル・スクリプトがメッセージを処理し、すべて戻り値で満たされていることを ToolTalk サービスに通知します。ToolTalk サービスは、状態を TT_HANDLED に設定して送信プロセスに応答を送信します。通常、メッセージを応答した後で安全にメッセージを破棄するには、tttk_message_destroy コマンドを使用してください。