dtkshコマンドコマンド
この付録は、dtkshによってサポートされているコマンドのリストを含んで
います。これらのコマンドの多くが、対応するMotif、Xtイントリンシクス、Xlibの
コマンドとほとんど同等です。値を返すコマンドは、コマンドを呼び出す際の最初の
パラメータである環境変数として、戻り変数を持っていなければなりません。
より多くの相違点を持つコマンドもあります。
次のサブセクションは、各dtkshコマンドの概観を示しています。
一般的に、パラメータの順序と型は対応するCプロシージャと同じです。例外は注記します。
コマンドの機能およびパラメータの詳細は、Xlib、Xtイントリンシクス、Motifプロシージャの
標準的なドキュメントを参照してください。
コマンドの定義において、var, var2, var3などの名前がついているパラメータは、
値が返される環境変数の名前をシェル・スクリプトで指定することを示します。
variableは、戻り値を受け取る環境変数を示します。
ブール値を返すコマンド(if文の一部として、直接、使用できます)は、注記します。
[]で囲まれたパラメータはオプションです。
組み込みXlibコマンド
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イントリンシクス・コマンドコマンド
XtイントリンシクスXtイントリンシクス・コマンド
新規ウィジェットを生成するのに使用するすべてのXtイントリンシクス・コマンドは、
ユーザに新規ウィジェットのウィジェット・クラスを指定することを要求します。
ウィジェット(またはガジェット)・クラス名はMotifが提供する標準のクラス名です。
例えば、Motifのプッシュ・ボタン・ウィジェットの名前はXmPushButton、Motifの
ラベル・ガジェットの名前はXmLabelGadgetです。
XtAddCallback widgetHandle callbackName ksh-command XtAddCallback
callbackName標準MotifまたはXtコールバック名前の1つで、XtまたはXm接頭辞を
取ったものです。例えば、activateCallbackなどです。
XtAddEventHandler widgetHandle eventMask nonMaskableFlag ksh-commandXtAddEventHandler
eventMaskは、mask|mask|maskという形式をとり、構成要素のmaskは、 Xイベント・
マスクの標準セットのいずれかです。nonMaskableFlagはtrueまたは
falseのいずれかです。
XtAddInput variable
[-r] fileDescriptor ksh-command
XtAddInput
Xツールキットを用いて、示されるファイル記述子を、交互の入力ソースとして登録
します。入力リソースが不要になり、ファイル記述子を閉じる場合、シェル・スクリプト
の入力ハンドラが、入力ソースを登録解除します。
-rオプション(rawモード)を指定すると、dtkshは、入力ソースから使用可能な
データを自動的に読み込みません。指定したkshellコマンドですべてのデータを読み込み
ます。-rが指定されていない場合は、ksh-commandで
指定したコマンドが、完全行(行がエスケープされていない改行文字またはファイルの
終りで終了している行)を読み込んだ時、またはファイルの終りに達した時のみ起動され
ます。rawモードは、テキストではないデータを処理するハンドラ、または dtkshを
データ行で自動的に読み込みたくないハンドラでは有効です。ファイルの終りが検出され
ると、シェル・スクリプトの入力ハンドラが、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
XtCreateManagedWidget
parentWidgetHandle [resource:value ...]
XtCreatePopupShell variable widgetName widgetClass
parentWidgetHandle [resource:value ...]
XtCreateWidget variable widgetName widgetClass
parentWidgetHandle[resource:value ...]
XtDestroyWidget widgetHandle [widgetHandle ...]
XtDisplay variable widgetHandleXtDisplay
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 widgetHandlewidgetClass
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 widgetHandlecallbackName
callbackNameは、標準のMotifまたはXtコールバックの名前の1つで、XtまたはXmを
取ったものです。例えば、activateCallbackなどです。
XtRemoveCallback widgetHandlecallbackName ksh-command
callbackNameは、標準のMotifまたはXtコールバックの名前の1つで、XtまたはXmを
取ったものです。例えば、activateCallbackなどです。
従来のXtコールバックを指定する場合、コールバックを最初に登録したときに指定した
のと同じkshellコマンド文字列を、コールバックを削除したときに指定する必要が
あります。
XtRemoveEventHandler widgetHandleeventMask nonMaskableFlag ksh-command
eventMaskは、mask|mask|maskという形式をとり、 構成要素のmaskは、
Xイベント・マスクの標準セットのいずれかです。
nonMaskableFlagに設定されるButtonPressMaskはtrueまたは
falseのどちらかです。
従来のXtイベント・ハンドラを指定した場合、イベント・ハンドラを最初に登録したとき
に指定したのと同じeventMaskとnonMaskableFlagの設定、および
kshellコマンド文字列を、イベント・ハンドラを削除したときに指定する必要がありま
す。
XtRemoveInput inputId
inputIdは、XtAddInputコマンドを使用して代わりの入力ソースを
登録したときに指定した環境変数に返されるハンドルです。
XtRemoveTimeOut timeoutId
timeoutIdは、XtAddTimeOutコマンドを使用してタイムアウトを
登録したときに、指定した環境変数に返されるハンドルです。
XtRemoveWorkProc workprocID
workprocIDは、XtAddWorkProcコマンドを使用してワーク・プロシージャを
登録したときに、指定した環境変数に返されるハンドルです。
XtScreen variable widgetHandle
XtSetSensitive widgetHandlestate
stateは、 trueまたはfalseのどちらかです。
XtSetValues widgetHandle
resource:value [resource:value ...]
XtUninstallTranslations widgetHandle
XtUnmanageChild widgetHandle
XtUnmanageChildren widgetHandle[widgetHandle ...]
XtUnmapWidget widgetHandle
XtUnrealizeWidget widgetHandle
XtWindow variable widgetHandle
組み込みMotifコマンドコマンドMotifMotifコマンド
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 variable parentWidgetHandle
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コマンドは、Cプロシージャとは異なり、画面のポインタとカラーマップの代わりに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 widgetHandleeventHandle
eventHandleは、Xイベントを参照します。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 widgetHandlevalue
XmScrollBarGetValues widgetHandlevariable 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、IALOG_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 toPosition string
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
組み込み共通デスクトップ環境アプリケーション・ヘルプ・コマンド
コマンドCDEアプリケーション・ヘルプ
アプリケーション・ヘルプ・コマンド
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_SELECT_INVALID、HELP_SELECT_ABORT
またはHELP_SELECT_ERRORのいずれかの文字列を設定します。
var2には、選択したウィジェットのwidgetHandleを設定します。
DtHelpSetCatalogName catalogName
組み込み共通デスクトップ環境印刷設定コマンド
コマンド印刷ダイアログ
印刷ダイアログ・コマンド
DtCreatePrintSetupBox variable parent name [resource:value...]
印刷の設定ボックスを作成します。
DtCreatePrintSetupDialog variable parent name [resource:value...]
印刷の設定ダイアログを作成します。
組み込みローカリゼーション・コマンドコマンド
ローカリゼーションローカリゼーション・コマンド
catopen variable catalogName
指定したメッセージ・カタログを開き、variableで指定した環境変数に
カタログIDを返します。シェル・スクリプトが、メッセージ・カタログに関連したファイル記述子を閉じる必要がある場合は、catcloseを使用して閉じます。
catgets variable catalogId setNumber messageNumber defaultMessageString
catalogIdパラメータに関連したメッセージ・カタログから、要求したメッセージ文字列を
取り出します。メッセージ文字列を見つけることができなかった場合は、デフォルトの
メッセージ文字列を返します。いずれの場合も、variableで指定した
環境変数に入れられます。
catclose catalogId
catalogで指定したメッセージ・カタログを閉じます。
組み込みlibDtセッション管理コマンドコマンドlibDtセッション管理
libDtセッション管理コマンド
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のいずれかを設定します。
シェル・ウィンドウが、初期のアイコン化状態を設定できるようにします。このコマンドは、
ウィジェットをもつウィンドウが、認識はされているがまだ表示されていない場合のみ実行できます。
組み込みlibDtワークスペース管理コマンドコマンドワークスペース管理
ワークスペース管理コマンド
DtWsmAddCurrentWorkspaceCallback variable widgetHandle ksh-command
ワークスペースを変更するたびに、指定したkshellを評価します。このコールバックを
もつハンドルは、variableによって指定される環境変数に返されます。
widgetHandleによって指定されているウィジェットは、シェル・ウィジェットです。
DtWsmRemoveWorkspaceCallback callbackHandle
ワークスペースの通知コールバックを削除します。ワークスペースのコールバックを削除
するとき、DtWsmAddCurrentWorkspaceCallbackでコールバックを格納したときに返されたコールバックハンドルを渡す必要があります。
DtWsmGetCurrentWorkspace display rootWindow variable
variableによって指定された環境変数に、ユーザの現在のワークスペースを示す
Xアトムを返します。
DtWsmSetCurrentWorkspace widgetHandle workspaceNameAtom
workspaceNameAtomによって指定されたワークスペースに、ユーザの現在のワークスペースを変更します。
正常終了した場合は0を返し、異常終了した場合は1を返します。
DtWsmGetWorkspaceList display rootWindow variable
カンマで区切られたXアトムの文字列を返します。これは、ユーザのために定義された
ワークスペースの現在のセットを示しており、variableによって指定された
環境変数に返されます。
正常終了した場合は0を返し、異常終了した場合は1を返します。
DtWsmGetWorkspacesOccupied display window variable
カンマで区切られたXアトムの文字列を返します。これは、指定したシェル・ウィンドウに
よって使用されている現在のワークスペースのセットを示しており、variableによって
指定された環境変数に返されます。
正常終了した場合は0を返し、異常終了した場合は1を返します。
DtWsmSetWorkspacesOccupied display window workspaceList
指定したシェル・ウィンドウを、workspaceList文字列によって指定した
ワークスペースのセットに移動します。workspaceListは、カンマで区切られたXアトムの
リストです。
DtWsmAddWorkspaceFunctions display window
ウィンドウ・マネージャ・メニューに、ウィンドウを他のワークスペースに移動するときに
使用する関数を取り込みます。このコマンドは、ウィンドウが描画状態の場合のみ動作
します。
DtWsmRemoveWorkspaceFunctions display window
ウィンドウ・マネージャ・メニューに、ウィンドウを他のワークスペースに移動するときに
使用する関数を表示しないようにします。このコマンドは、ウィンドウが描画状態の場合のみ動作します。
DtWsmOccupyAllWorkspaces display window
ウィンドウが、新規ワークスペースも含めて、作成したすべてのワークスペースを占有するように要求します。
DtWsmGetCurrentBackdropWindows display rootWindow variable
カンマで区切られたウィンドウIDの文字列を返します。このIDはルート・バックドロップ・ウィンドウを示します。
組み込みlibDtアクションコマンドコマンド
アクションアクション・コマンド
この節で説明するコマンドは、アクション・データベースを読み込むツール、データ
ベースに定義したアクションの情報を参照するツール、およびアクションの起動を要求
するツールを提供します。
DtDbLoad
アクションとデータ型のデータベースを読み込みます。複数回呼び出しを行うと、古い
データベースは、新しいデータベースを読み込む前に解放されます。このコマンドは、
他のlibDtアクション・コマンドまたはlibDtデータ入力コマンドの前に呼び出します。
シェル・スクリプトも、DtDbReloadNotifyコマンドを使用します。
そのため、新しいデータベースが読み込まれるとシェル・スクリプトに通知されます。
DtDbReloadNotify ksh-command
アクションまたはデータ型データベースの再読み込みが必要なときに、通知を要求します。
通知を受け取ると、特別なkshellコマンドが実行されます。通常、kshellコマンドは、
DtDbLoadコマンドの呼び出しを含んでいます。
DtActionExists actionName
actionNameパラメータによって指定した名前のデータベースに、アクションが存在するか
どうかテストします。条件文に使用する値を返します。
DtActionLabel variable actionName
指定したアクションに関連したローカルなLABEL属性を返します。アクションが存在しない
場合は、空の文字列を返します。
DtActionDescription variable actionName
指定したアクションに関連したDESCRIPTION属性の値を返します。アクションが定義
されていない場合、またはDESCRIPTION属性が存在していない場合、空の文字列が返され
ます。
組み込みlibDtデータ・タイピング・コマンドコマンド
データ・タイピングデータ・タイピング・コマンド
コマンドlibdtlibDtコマンド
DtLoadDataTypes
データ・タイピング・データベースを読み込みます。他のデータ・タイピング・コマンドの前に起動します。
DtDtsFileToDataType variable filePath
variable引き数によって指定されたファイルに関連したデータ・タイプの名前を返します。ファイルがタイプされることができない場合は、variable引き数には空の文字列が設定されます。
DtDtsFileToAttributeValue variable filePath attrName
指定したファイルに関連したデータ・タイプの指定した属性の値を示す文字列を返します。
属性が定義されていない場合、またはファイルがタイプされることができない場合は、
variable引き数には空の文字列が設定されます。
DtDtsFileToAttributeList variable filePath
指定したファイルに関連したデータ・タイプに定義された属性の名前を、空白で区切られた
リストで返します。シェル・スクリプトは、DtDtsFileToAttributeValueコマンドを
使用して、属性の個々の値を照会できます。ファイルがタイプされることができない場合、
variable変数には空の文字列が設定されます。このコマンドは、定義された属性の
名前だけを返して値は返さないという点で、対応するCプログラミングのコマンドとは
異なります。
DtDtsDataTypeToAttributeValue variable dataType attrName optName
指定したデータ・タイプの指定した属性の値を示す文字列を返します。属性が定義されて
いない場合、または指定したデータ・タイプが存在しない場合は、variable引き数には、
空の文字列が設定されます。
DtDtsDataTypeToAttributeList variable dataType optName
指定したデータ・タイプに定義された属性の名前を、空白で区切られたリストで返します。
シェル・スクリプトは、DtDtsDataTypeToAttributeValueコマンドを使用して、属性の
個々の値を照会できます。データ・タイプが定義されていない場合、variableに
空の文字列が設定されます。このコマンドは、定義された属性の名前のみを返し値は
返さない点が、対応するCプログラミングのコマンドと異なります。
DtDtsFindAttribute variable name value
name引き数によって指定された属性で、value引き数によって
指定された値を持つデータ・タイプ名を、空白で区切られたリストで返します。
エラーが生じた場合、variable引き数には空の文字列が設定されます。
DtDtsDataTypeNames variable
データ・タイプのデータベースに現在定義されているすべてのデータ・タイプを、空白で
区切られたリストで返します。エラーが生じた場合、variable引き数には空の
文字列が設定されます。
DtDtsSetDataType variable filePath dataType override
指定したディレクトリのデータ・タイプを設定します。variable引き数には、
ディレクトリに、結果として保存されたデータ・タイプが設定されます。
DtDtsDataTypeIsAction dataType
特定のデータ・タイプがアクション・エントリを表すかどうかを決定します。
条件文で使用する値を返します。
その他の組み込みlibDtコマンドcommands
libDtlibDtコマンド
DtGetHourGlassCursor variable display
標準のDt時計表示カーソルに関連したXカーソルIDを返します。
DtTurnOnHourGlass widgetHandle
指定したウィジェットの標準のDt時計表示カーソルを有効にします。
DtTurnOffHourGlass widgetHandle
指定したウィジェットの標準のDt時計表示カーソルを無効にします。
組み込みデスクトップ・サービス・メッセージ・セット・コマンドコマンドメッセージ・セット
メッセージ・セット・コマンド
次のコマンドは、シェル・スクリプトがデスクトップ・サービス・プロトコルを利用可能にする
デスクトップ・サービス・メッセージ・セットの最小のサブセットを実行しています。
多くのToolTalkコマンドは、Cプログラミングの呼び出しに関連したコマンドとわずかに
異なっています。通常はポインタを返すToolTalkコマンドでは、Cアプリケーションが、
tt_ptr_error()関数を呼び出すことによってポインタを有効にします。
tt_ptr_error()関数呼び出しは、ポインタが有効であるかどうかを示すTt_status値を
返します。有効ではない場合、その理由を示します。kshellコードの設計上の理由で、
シェル・スクリプトが見る文字列ポインタはCコードが返す文字列ポインタと同じでは
ありません。シェルのプログラミング中は、重要な情報が文字列ポインタではなく文字列
の値で示されるため、通常、これは問題になりません。
シェル・スクリプトがポインタの状態を取得できるようにするために、通常はポインタを
返すコマンドは、自動的にポインタに関連するTt_status値も返します。
シェル・スクリプトは元のポインタの有効性をチェックするために呼び出しを追加する
必要はありません。ポインタのエラーが生じた場合、dtkshはポインタの値に空の文字列を返し、Tt_statusコードを設定します。
Tt_status値が、status引き数に返されます。
Tt_status値はエラーを表す文字列で、次の値のいずれかです。
TT_OK
TT_WRN_NOTFOUND
TT_WRN_STALE_OBJID
TT_WRN_STOPPED
TT_WRN_SAME_OBJID
TT_WRN_START_MESSAGE
TT_ERR_CLASS
TT_ERR_DBAVAIL
TT_ERR_DBEXIST
TT_ERR_FILE
TT_ERR_INVALID
TT_ERR_MODE
TT_ERR_ACCESS
TT_ERR_NOMP
TT_ERR_NOTHANDLER
TT_ERR_NUM
TT_ERR_OBJID
TT_ERR_OP
TT_ERR_OTYPE
TT_ERR_ADDRESS
TT_ERR_PATH
TT_ERR_POINTER
TT_ERR_PROCID
TT_ERR_PROPLEN
TT_ERR_PROPNAME
TT_ERR_PTYPE
TT_ERR_DISPOSITION
TT_ERR_SCOPE
TT_ERR_SESSION
TT_ERR_VTYPE
TT_ERR_NO_VALUE
TT_ERR_INTERNAL
TT_ERR_READONLY
TT_ERR_NO_MATCH
TT_ERR_UNIMP
TT_ERR_OVERFLOW
TT_ERR_PTPE_START
TT_ERR_CATEGORY
TT_ERR_DBUPDATE
TT_ERR_DBFULL
TT_ERR_DBCONSIST
TT_ERR_STATE
TT_ERR_NOMEM
TT_ERR_SLOTNAME
TT_ERR_XDR
TT_DESKTOP_EPERM
TT_DESKTOP_ENOENT
TT_DESKTOP_EINTR
TT_DESKTOP_EIO
TT_DESKTOP_EAGAIN
TT_DESKTOP_ENOMEM
TT_DESKTOP_EACCES
TT_DESKTOP_EFAULT
TT_DESKTOP_EEXIST
TT_DESKTOP_ENODEV
TT_DESKTOP_ENOTDIR
TT_DESKTOP_EISDIR
TT_DESKTOP_EINVAL
TT_DESKTOP_ENFILE
TT_DESKTOP_EMFILE
TT_DESKTOP_ETXBSY
TT_DESKTOP_EFBIG
TT_DESKTOP_ENOSPC
TT_DESKTOP_EROFS
TT_DESKTOP_EMLINK
TT_DESKTOP_EPIPE
TT_DESKTOP_ENOMSG
TT_DESKTOP_EDEADLK
TT_DESKTOP_ECANCELED
TT_DESKTOP_ENOTSUP
TT_DESKTOP_ENODATA
TT_DESKTOP_EPROTO
TT_DESKTOP_ENOTEMPTY
TT_DESKTOP_ETIMEDOUT
TT_DESKTOP_EALREADY
TT_DESKTOP_UNMODIFIED
TT_MEDIA_ERR_SIZE
TT_MEDIA_ERR_FORMAT
一部のコマンドは、パラメータとしてメッセージ・スコープを取ります。スコープは、
発信メッセージを受け取る可能性のあるクライアントを示します。これらのコマンドは、
scopeパラメータが、次のいずれかの値に設定されます。
TT_SCOPE_NONE
TT_SESSION
TT_FILE
TT_BOTH
TT_FILE_IN_SESSION
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によって返されるprocIDsは、局所にスペースを含みます。
kshellが(局所にスペースを含む1つのパラメータではなく)複数のパラメータとしてprocIDを解釈しないように、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 s essId 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
実行されるオペレーションを表す
文字列を含んでいます。
TTTDT_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が設定されていると、このコマンドは、
patternsの作成時に指定したスコープに、Get_Modified、SaveおよびRevert
メッセージの処理を登録します。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要求は、処理中のToolTalクライアントに、
pathname引き数で指定したファイルで保留している変更を保存するかどうかをたずねます。
指定したタイムアウト内に肯定の応答を受信すると、TT_OKというステータスが返されます。
それ以外の場合は、標準のTt_statusエラー値の1つが返されます。
ttdt_Revert status pathName scope timeout
Revert要求を、指定したスコープに送信し、応答または指定したタイムアウト
(ミリ秒単位)が経過するのを待ちます。Revert要求は、処理中のToolTalクライアントに、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コマンドを使用します。