From 39ffb88b3a6523e9258bc6e4f3948a09e63b269f Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 31 May 2011 20:03:23 -0600 Subject: Add id attributes to funcsynopsis to allow other docs to olink to them. Signed-off-by: Matt Dew Reviewed-by: Alan Coopersmith Reviewed-by: Gaetan Nadon --- specs/AsciiSource.xml | 8 ++++---- specs/CH2.xml | 24 ++++++++++++------------ specs/Dialog.xml | 4 ++-- specs/Form.xml | 2 +- specs/List.xml | 8 ++++---- specs/Paned.xml | 10 +++++----- specs/Panner.xml | 2 +- specs/Porthole.xml | 2 +- specs/Scrollbar.xml | 6 +++--- specs/SimpleMenu.xml | 6 +++--- specs/TextFuncs.xml | 32 ++++++++++++++++---------------- specs/TextSink.xml | 20 ++++++++++---------- specs/TextSource.xml | 12 ++++++------ specs/Toggle.xml | 8 ++++---- specs/Tree.xml | 2 +- 15 files changed, 73 insertions(+), 73 deletions(-) (limited to 'specs') diff --git a/specs/AsciiSource.xml b/specs/AsciiSource.xml index bd51f99..ba170b9 100644 --- a/specs/AsciiSource.xml +++ b/specs/AsciiSource.xml @@ -224,7 +224,7 @@ requested with a call to XtGetValues. This memory is alloc fly, and remains valid until the next time a string needs to be allocated. You may save memory by freeing this string as soon as you are done with it by calling XawAsciiSourceFreeString. - + void XawAsciiSourceFreeString Widget w @@ -257,7 +257,7 @@ the next call to XtGetValues occurs, or when the widget is To save the changes made in the current text source into a file use XawAsciiSave. - + Boolean XawAsciiSave Widget w @@ -289,7 +289,7 @@ only works on an AsciiSrc of type XawAsciiFile. To save the contents of the current text buffer into a named file use XawAsciiSaveAsFile. - + Boolean XawAsciiSaveAsFile Widget w @@ -335,7 +335,7 @@ To find out if the text buffer in an AsciiSrc object has changed since the last time it was saved with XawAsciiSave or queried use XawAsciiSourceChanged. - + Boolean XawAsciiSourceChanged Widget w diff --git a/specs/CH2.xml b/specs/CH2.xml index 18bebc3..cea1515 100644 --- a/specs/CH2.xml +++ b/specs/CH2.xml @@ -77,7 +77,7 @@ a tree of widgets created by this application. - + Widget XtAppInitialize XtAppContext app_context_return @@ -231,7 +231,7 @@ managed if the parent is already realized. To allocate, initialize, and manage a widget, use XtCreateManagedWidget . - + Widget XtCreateManagedWidget String name @@ -675,7 +675,7 @@ for performance reasons. Creates an X window for the widget and, if it is a composite widget, realizes each of its managed children. - + void XtRealizeWidget Widget w @@ -710,7 +710,7 @@ widgets, it is ready to process the events that will be delivered by the X Server to this client. A function call that will process the events is XtAppMainLoop. - + void XtAppMainLoop XtAppContext app_context @@ -792,7 +792,7 @@ widget windows are mapped (made viewable) automatically by - + void XtSetMappedWhenManaged Widget w @@ -837,7 +837,7 @@ The definition for XtMapWidget is: - + void XtMapWidget Widget w @@ -868,7 +868,7 @@ parent can avoid wasteful duplication of geometry processing and the associated ``screen flash''. - + void XtManageChildren WidgetList children @@ -918,7 +918,7 @@ see the X Toolkit Intrinsics - C Language InterfaceXtDestroyWidget - + void XtDestroyWidget Widget w @@ -957,7 +957,7 @@ To retrieve the current value of a resource attribute associated with a widget instance, use XtGetValues . - + void XtGetValues Widget w @@ -1018,7 +1018,7 @@ To modify the current value of a resource attribute associated with a widget instance, use XtSetValues . - + void XtSetValues Widget w @@ -1100,7 +1100,7 @@ Widgets can communicate changes in their state to their clients by means of a callback facility. The format for a client's callback handler is: - + void CallbackProc Widget w @@ -1194,7 +1194,7 @@ The second method for registering callbacks is to use XtAddCallback after the widget has been created. - + void XtAddCallback Widget w diff --git a/specs/Dialog.xml b/specs/Dialog.xml index f77006c..ab09dba 100644 --- a/specs/Dialog.xml +++ b/specs/Dialog.xml @@ -580,7 +580,7 @@ available through the Dialog widget itself. To return the character string in the text field, use - + String XawDialogGetValueString Widget w @@ -617,7 +617,7 @@ the function XawAsciiSourceFreeString. To add a new button to the Dialog widget use XawDialogAddButton. - + void XawDialogAddButton Widget w diff --git a/specs/Form.xml b/specs/Form.xml index 13cc36a..cd41ef9 100644 --- a/specs/Form.xml +++ b/specs/Form.xml @@ -488,7 +488,7 @@ To force or defer a re-layout of the Form, use - + void XawFormDoLayout Widget w diff --git a/specs/List.xml b/specs/List.xml index 0bad43d..fb5be8b 100644 --- a/specs/List.xml +++ b/specs/List.xml @@ -652,7 +652,7 @@ operating systems, and had to be changed. To change the list that is displayed, use XawListChange . - + void XawListChange Widget w @@ -738,7 +738,7 @@ has been changed again with this function or with XtSetValuesXawListHighlight . - + void XawListHighlight Widget w @@ -786,7 +786,7 @@ the highlighted item is unhighlighted before the new item is highlighted. To unhighlight the currently highlighted item in the list, use XawListUnhighlight . - + void XawListUnhighlight Widget w @@ -814,7 +814,7 @@ Specifies the List widget. To retrieve the list element that is currently set, use XawListShowCurrent . - + XawListReturnStruct *XawListShowCurrent Widget w diff --git a/specs/Paned.xml b/specs/Paned.xml index 90c3809..28b346c 100644 --- a/specs/Paned.xml +++ b/specs/Paned.xml @@ -980,7 +980,7 @@ To enable or disable a child's request for pane resizing, use XawPanedAllowResize : - + void XawPanedAllowResize Widget w @@ -1029,7 +1029,7 @@ constraint resource for the child. To change the minimum and maximum height settings for a pane, use XawPanedSetMinMax : - + void XawPanedSetMinMax Widget w @@ -1082,7 +1082,7 @@ constraint resources for the child. To retrieve the minimum and maximum height settings for a pane, use XawPanedGetMinMax : - + void XawPanedGetMinMax Widget w @@ -1137,7 +1137,7 @@ To enable or disable automatic recalculation of pane sizes and positions, use XawPanedSetRefigureMode : - + void XawPanedSetRefigureMode Widget w @@ -1182,7 +1182,7 @@ relayout until after all changes have been made. To retrieve the number of panes in a paned widget use XawPanedGetNumSub: - + int XawPanedGetNumSub Widget w diff --git a/specs/Panner.xml b/specs/Panner.xml index a04bb1a..7a638c5 100644 --- a/specs/Panner.xml +++ b/specs/Panner.xml @@ -688,7 +688,7 @@ The default bindings for Panner are: The functions registered on the reportCallback list are invoked by the notify action as follows: - + void ReportProc Widget panner diff --git a/specs/Porthole.xml b/specs/Porthole.xml index beda434..a0a87c1 100644 --- a/specs/Porthole.xml +++ b/specs/Porthole.xml @@ -262,7 +262,7 @@ Panner widget. The functions registered on the reportCallback list are invoked whenever the managed child changes size or position: - + void ReportProc Widget porthole diff --git a/specs/Scrollbar.xml b/specs/Scrollbar.xml index 87f6d68..5b22cba 100644 --- a/specs/Scrollbar.xml +++ b/specs/Scrollbar.xml @@ -663,7 +663,7 @@ The procedural interface for these functions is described here. The calling interface to the scrollProc callback procedure is: - + void ScrollProc Widget scrollbar @@ -720,7 +720,7 @@ be greater than the length of the Scrollbar. The calling interface to the jumpProc callback procedure is: - + void JumpProc Widget scrollbar @@ -792,7 +792,7 @@ To set the position and length of a Scrollbar thumb, use - + void XawScrollbarSetThumb Widget w diff --git a/specs/SimpleMenu.xml b/specs/SimpleMenu.xml index 84ba039..0e039b1 100644 --- a/specs/SimpleMenu.xml +++ b/specs/SimpleMenu.xml @@ -691,7 +691,7 @@ application uses dynamic menu creation. In these cases an application will need to register this global action routine by calling XawSimpleMenuAddGlobalActions: - + void XawSimpleMenuAddGlobalActions XtAppContext app_con @@ -725,7 +725,7 @@ is realized. To get the currently highlighted menu entry use XawSimpleMenuGetActiveEntry: - + Widget XawSimpleMenuGetActiveEntry Widget w @@ -757,7 +757,7 @@ To clear the SimpleMenu widget's internal information about the currently highlighted menu entry use XawSimpleMenuClearActiveEntry: - + Widget XawSimpleMenuClearActiveEntry Widget w diff --git a/specs/TextFuncs.xml b/specs/TextFuncs.xml index 0d2ae81..9057c33 100644 --- a/specs/TextFuncs.xml +++ b/specs/TextFuncs.xml @@ -109,7 +109,7 @@ deprecated and will eventually be removed from the implementation. To select a piece of text, use XawTextSetSelection : - + void XawTextSetSelection Widget w @@ -168,7 +168,7 @@ effect on CUT_BUFFER0. To unhighlight previously highlighted text in a widget, use XawTextUnsetSelection: - + void XawTextUnsetSelection Widget w @@ -196,7 +196,7 @@ Specifies the Text widget. To retrieve the text that has been selected by this text widget use XawTextGetSelectionPos: - + void XawTextGetSelectionPos Widget w @@ -249,7 +249,7 @@ If the returned values are equal, no text is currently selected. To modify the text in an editable Text widget use XawTextReplace: - + int XawTextReplace Widget w @@ -373,7 +373,7 @@ text is inserted after start. To search for a string in the Text widget, use XawTextSearch: - + XawTextPosition XawTextSearch Widget w @@ -433,7 +433,7 @@ found then the value XawTextSearchError is returned. To redisplay a range of characters, use XawTextInvalidate: - + void XawTextInvalidate Widget w @@ -487,7 +487,7 @@ enabled. To enable redisplay, use XawTextEnableRedisplay: - + void XawTextEnableRedisplay Widget w @@ -519,7 +519,7 @@ was called and allows future changes to be reflected immediately. To disable redisplay while making several changes, use XawTextDisableRedisplay. - + void XawTextDisableRedisplay Widget w @@ -550,7 +550,7 @@ is called. To display batched updates, use XawTextDisplay: - + void XawTextDisplay Widget w @@ -584,7 +584,7 @@ To obtain the character position of the left-most character on the first line displayed in the widget (the value of the displayPosition resource), use XawTextTopPosition. - + XawTextPosition XawTextTopPosition Widget w @@ -610,7 +610,7 @@ Specifies the Text widget. To assign a new selection array to a text widget use XawTextSetSelectionArray: - + void XawTextSetSelectionArray Widget w @@ -653,7 +653,7 @@ Calling this function is equivalent to setting the value of the To move the insertion point to the specified source position, use XawTextSetInsertionPoint: - + void XawTextSetInsertionPoint Widget w @@ -697,7 +697,7 @@ equivalent to setting the insertPosition resource. To obtain the current position of the insertion point, use XawTextGetInsertionPoint: - + XawTextPosition XawTextGetInsertionPoint Widget w @@ -729,7 +729,7 @@ The result is equivalent to retrieving the value of the To replace the text source in the specified widget, use XawTextSetSource: - + void XawTextSetSource Widget w @@ -783,7 +783,7 @@ A display update will be performed if redisplay is enabled. To obtain the current text source for the specified widget, use XawTextGetSource: - + Widget XawTextGetSource Widget w @@ -814,7 +814,7 @@ using. To enable and disable the insertion point, use XawTextDisplayCaret: - + void XawTextDisplayCaret Widget w diff --git a/specs/TextSink.xml b/specs/TextSink.xml index bafe557..04074dc 100644 --- a/specs/TextSink.xml +++ b/specs/TextSink.xml @@ -192,7 +192,7 @@ to be used as a sink by itself. To display a section of the text buffer contained in the text source use the function DisplayText: - + void DisplayText Widget w @@ -283,7 +283,7 @@ be displayed. The function that controls the display of the text cursor is InsertCursor. This function will be called whenever the text widget desires to change the state of, or move the insert point. - + void InsertCursor Widget w @@ -352,7 +352,7 @@ This behavior will be used if you specify XtInheritClearToBackground for this method. - + void ClearToBackground Widget w @@ -426,7 +426,7 @@ Specifies the height, in pixels, of the Region to clear. To find the text character position that will be rendered at a given x location the Text widget uses the function FindPosition: - + void FindPosition Widget w @@ -540,7 +540,7 @@ widget will only call it one line at a time. Another means of finding a text position is provided by the Resolve function: - + void Resolve Widget w @@ -625,7 +625,7 @@ functionality. To find the distance in pixels between two text positions on the same line use the function FindDistance. - + void FindDistance Widget w @@ -731,7 +731,7 @@ widget, use the function MaxLines. The TextSink already de this function to compute the maximum number of lines by using the height of font. - + int MaxLines Widget w @@ -774,7 +774,7 @@ the function MaxHeight. The TextSink already defines this function to compute the maximum height of the window by using the height of font. - + int MaxHeight Widget w @@ -819,7 +819,7 @@ The TextSink already defines this function to set the tab x location in pixels to be the number of characters times the figure width of font. - + void SetTabs Widget w @@ -873,7 +873,7 @@ to it into whatever internal positions the TextSink uses for tab placement. To get the size and location of the insert point use the GetCursorBounds function. - + void GetCursorBounds Widget w diff --git a/specs/TextSource.xml b/specs/TextSource.xml index 51b9ae0..69c20a5 100644 --- a/specs/TextSource.xml +++ b/specs/TextSource.xml @@ -140,7 +140,7 @@ used as a source by itself and bad things will probably happen. To read the text in a text source use the Read function: - + XawTextPosition Read Widget w @@ -210,7 +210,7 @@ portion of the text buffer is fully retrieved. To replace or edit the text in a text buffer use the Replace function: - + XawTextPosition Replace Widget w @@ -310,7 +310,7 @@ To search the text source for one of the predefined boundary types use the Scan function: - + XawTextPosition Scan Widget w @@ -396,7 +396,7 @@ position of that end. To search for a particular string use the Search function. - + XawTextPosition Search Widget w @@ -466,7 +466,7 @@ the ConvertSelection function, to attempt the selection conversion. - + Boolean ConvertSelections Widget w @@ -571,7 +571,7 @@ If the source needs to know when the text selection is modified it should define a SetSelection procedure: - + void SetSelection Widget w diff --git a/specs/Toggle.xml b/specs/Toggle.xml index d5c2398..5be106c 100644 --- a/specs/Toggle.xml +++ b/specs/Toggle.xml @@ -608,7 +608,7 @@ the Toggle to a radio group, or remove the Toggle from a radio group, use XawToggleChangeRadioGroup. - + void XawToggleChangeRadioGroup Widgetw, radio_group @@ -654,7 +654,7 @@ To find the currently selected Toggle in a radio group of Toggle widgets use XawToggleGetCurrent. - + XtPointer XawToggleGetCurrent XtPointer XawToggleGetCurrent(radio_group) @@ -690,7 +690,7 @@ To change the Toggle that is currently set in a radio group use XawToggleSetCurrent. - + void XawToggleSetCurrent voidXawToggleSetCurrent(radio_group, radio_data) @@ -743,7 +743,7 @@ To unset all Toggle widgets in a radio group use XawToggleUnsetCurrent. - + void XawToggleUnsetCurrent void XawToggleUnsetCurrent(radio_group) diff --git a/specs/Tree.xml b/specs/Tree.xml index bb51e80..1d68775 100644 --- a/specs/Tree.xml +++ b/specs/Tree.xml @@ -383,7 +383,7 @@ to False and then use the routine to arrange the children. - + void XawTreeForceLayout Widget w -- cgit v1.2.1