From 272e57235cd60a2e65ac8258d96a02eb3939b687 Mon Sep 17 00:00:00 2001 From: marha Date: Fri, 25 Mar 2011 10:41:05 +0000 Subject: git update until 25 Mar 2011 xserver fontconfig glproto libXau libXft libXmu libfontenc libxcb mesa mkfontscale pixman randrproto xkeyboard-config xtrans xwininfo updated following packages: xproto-7.0.21 xineramaproto-1.2.1 libXt-1.1.1 libxkbfile-1.0.7 libXpm-3.5.9 libXfont-1.4.3 libXaw-1.0.9 bdftopcf-1.0.3 encodings-1.0.4 fixesproto-5.0 font-adobe-100dpi-1.0.3 font-adobe-75dpi-1.0.3 font-adobe-utopia-100dpi-1.0.4 font-adobe-utopia-75dpi-1.0.4 font-adobe-utopia-type1-1.0.4 font-alias-1.0.3 font-arabic-misc-1.0.3 font-bh-100dpi-1.0.3 font-bh-75dpi-1.0.3 font-bh-lucidatypewriter-100dpi-1.0.3 font-bh-lucidatypewriter-75dpi-1.0.3 font-bh-ttf-1.0.3 font-bh-type1-1.0.3 font-bitstream-100dpi-1.0.3 font-bitstream-75dpi-1.0.3 font-bitstream-speedo-1.0.2 font-bitstream-type1-1.0.3 font-cronyx-cyrillic-1.0.3 font-cursor-misc-1.0.3 font-daewoo-misc-1.0.3 font-dec-misc-1.0.3 font-ibm-type1-1.0.3 font-isas-misc-1.0.3 font-jis-misc-1.0.3 font-micro-misc-1.0.3 font-misc-cyrillic-1.0.3 font-misc-ethiopic-1.0.3 font-misc-meltho-1.0.3 font-misc-misc-1.1.2 font-mutt-misc-1.0.3 font-schumacher-misc-1.1.2 font-screen-cyrillic-1.0.4 font-sony-misc-1.0.3 font-sun-misc-1.0.3 font-util-1.2.0 font-winitzki-cyrillic-1.0.3 font-xfree86-type1-1.0.4 --- libXaw/specs/TextFuncs.xml | 856 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 856 insertions(+) create mode 100644 libXaw/specs/TextFuncs.xml (limited to 'libXaw/specs/TextFuncs.xml') diff --git a/libXaw/specs/TextFuncs.xml b/libXaw/specs/TextFuncs.xml new file mode 100644 index 000000000..0d2ae8192 --- /dev/null +++ b/libXaw/specs/TextFuncs.xml @@ -0,0 +1,856 @@ + +Text Functions + + + + + +The following functions are provided as convenience routines for use with +the Text widget. Although many of these actions can be performed by +modifying resources, these interfaces are frequently more efficient. + + + +These data structures are defined in the Text widget's public header file, +<X11/Xaw/Text.h>. + + + + +typedef long XawTextPosition; + + + + +Character positions in the Text widget begin at 0 and end at n, where +n is the number of characters in the Text source widget. + + + + + + + +typedef struct { + int firstPos; + int length; + char *ptr; + unsigned long format; +} XawTextBlock, *XawTextBlockPtr; + + + + + + + + + firstPos + + + +The first position, or index, to use within the ptr field. +The value is commonly zero. + + + + + + length + + + +The number of characters to be used from the ptr field. +The number of characters used is commonly the number of characters +in ptr, and must not be greater than the length of the string +in ptr. + + + + + + ptr + + + +Contains the string to be referenced by the Text widget. + + + + + + format + + + +This flag indicates whether the data pointed to by ptr is char +or wchar_t. When the associated widget has international set +to false this field must be XawFmt8Bit. When the associated +widget has international set to true this field must be +either XawFmt8Bit or XawFmtWide. + + + + + + + + +Note: Previous versions of Xaw used +FMT8BIT , +which has been retained for backwards compatibility. FMT8BIT is +deprecated and will eventually be removed from the implementation. + + + +Selecting Text + + +To select a piece of text, use +XawTextSetSelection : + + + + void XawTextSetSelection + Widget w + XawTextPositionleft, right + + + + + + + w + + + +Specifies the Text widget. + + + + + + left + + + +Specifies the character position at which the selection begins. + + + + + + right + + + +Specifies the character position at which the selection ends. + + + + + + + +See section 5.4 for a description of XawTextPosition. +If redisplay is enabled, this function highlights the text and +makes it the PRIMARY selection. This function does not have any +effect on CUT_BUFFER0. + + + + + + +Unhighlighting Text + + +To unhighlight previously highlighted text in a widget, use +XawTextUnsetSelection: + + + + void XawTextUnsetSelection + Widget w + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +Getting Current Text Selection + + +To retrieve the text that has been selected by this +text widget use XawTextGetSelectionPos: + + + + void XawTextGetSelectionPos + Widget w + XawTextPosition*begin_return, *end_return + + + + + + + w + + + +Specifies the Text widget. + + + + + + begin_return + + + +Returns the beginning of the text selection. + + + + + + end_return + + + +Returns the end of the text selection. + + + + + + + +See section 5.4 for a description of XawTextPosition. +If the returned values are equal, no text is currently selected. + + + +Replacing Text + + +To modify the text in an editable Text widget use XawTextReplace: + + + + int XawTextReplace + Widget w + XawTextPositionstart, end + XawTextBlock *text + + + + + + + w + + + +Specifies the Text widget. + + + + + + start + + + +Specifies the starting character position of the text replacement. + + + + + + end + + + +Specifies the ending character position of the text replacement. + + + + + + text + + + +Specifies the text to be inserted into the file. + + + + + + + +This function will not +be able to replace text in read-only text widgets. It will also only +be able to append text to an append-only text widget. + + + +See section 5.4 for a description of XawTextPosition and +XawTextBlock. + + + +This function may return the following values: + + + + XawEditDone + + + + +The text replacement was successful. + + + + + + XawPositionError + + + + +The edit mode is XawtextAppend and start is not the position of +the last character of the source. + + + + + + XawEditError + + + + +Either the Source was read-only or the range to be deleted is larger +than the length of the Source. + + + + + + + + +The XawTextReplace arguments start and +end represent the text source character positions for the +existing text that is to be replaced by the text in the text block. +The characters from start up to +but not including end are deleted, and the characters +specified on the text block are inserted in their place. If +start and end are equal, no text is deleted and the new +text is inserted after start. + + + +Searching for Text + + +To search for a string in the Text widget, use +XawTextSearch: + + + + XawTextPosition XawTextSearch + Widget w + XawTextScanDirection dir + XawTextBlock* text + + + + + + + w + + + +Specifies the Text widget. + + + + + + dir + + + +Specifies the direction to search in. Legal values are +XawsdLeft and XawsdRight. + + + + + + text + + + +Specifies a text block structure that contains the text to search for. + + + + + + + +See section 5.4 for a description of XawTextPosition and XawTextBlock. +The XawTextSearch function will begin at the insertion point +and search in the +direction specified for a string that matches the one passed in +text. If the string is found the location of the first +character in the string is returned. If the string could not be +found then the value XawTextSearchError is returned. + + + +Redisplaying Text + + +To redisplay a range of characters, use XawTextInvalidate: + + + + void XawTextInvalidate + Widget w + XawTextPositionfrom, to + + + + + + + w + + + +Specifies the Text widget. + + + + + + from + + + +Specifies the start of the text to redisplay. + + + + + + to + + + +Specifies the end of the text to redisplay. + + + + + + + +See section 5.4 for a description of XawTextPosition. +The XawTextInvalidate +function causes the specified range of characters to be redisplayed +immediately if redisplay is enabled or the next time that redisplay is +enabled. + + + + +To enable redisplay, use XawTextEnableRedisplay: + + + + void XawTextEnableRedisplay + Widget w + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +The XawTextEnableRedisplay function flushes any changes due to +batched updates when XawTextDisableRedisplay +was called and allows future changes to be reflected immediately. + + + + +To disable redisplay while making several changes, use +XawTextDisableRedisplay. + + + + void XawTextDisableRedisplay + Widget w + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +The XawTextDisableRedisplay function causes all changes to be +batched until either XawTextDisplay or XawTextEnableRedisplay +is called. + + + + +To display batched updates, use XawTextDisplay: + + + + void XawTextDisplay + Widget w + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +The XawTextDisplay function forces any accumulated updates to be +displayed. + + + +Resources Convenience Routines + + +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 + + + + + + + w + + + +Specifies the Text widget. + + + + + + + + +To assign a new selection array to a text widget use +XawTextSetSelectionArray: + + + + void XawTextSetSelectionArray + Widget w + XawTextSelectType* sarray + + + + + + + w + + + +Specifies the Text widget. + + + + + + sarray + + + +Specifies a selection array as defined in the section called \fBText +Selections for Application Programmers\fP. + + + + + + + +Calling this function is equivalent to setting the value of the +selectionTypes resource. + + + + +To move the insertion point to the specified source position, use +XawTextSetInsertionPoint: + + + + void XawTextSetInsertionPoint + Widget w + XawTextPosition position + + + + + + + w + + + +Specifies the Text widget. + + + + + + position + + + +Specifies the new position for the insertion point. + + + + + + + +See section 5.4 for a description of XawTextPosition. +The text will be scrolled vertically if necessary to make the line +containing the insertion point visible. Calling this function is +equivalent to setting the insertPosition resource. + + + + +To obtain the current position of the insertion point, use +XawTextGetInsertionPoint: + + + + XawTextPosition XawTextGetInsertionPoint + Widget w + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +See section 5.4 for a description of XawTextPosition. +The result is equivalent to retrieving the value of the +insertPosition resource. + + + + +To replace the text source in the specified widget, use +XawTextSetSource: + + + + void XawTextSetSource + Widget w + Widget source + XawTextPosition position + + + + + + + w + + + +Specifies the Text widget. + + + + + + source + + + +Specifies the text source object. + + + + + + position + + + +Specifies character position that will become the upper left hand corner +of the displayed text. This is usually set to zero. + + + + + + + +See section 5.4 for a description of XawTextPosition. +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 + + + + + + + w + + + +Specifies the Text widget. + + + + + + + +This function returns the text source that this Text widget is currently +using. + + + + +To enable and disable the insertion point, use +XawTextDisplayCaret: + + + + void XawTextDisplayCaret + Widget w + Boolean visible + + + + + + + w + + + +Specifies the Text widget. + + + + + + visible + + + +Specifies whether or not the caret should be displayed. + + + + + + + +If visible is False the insertion point will be disabled. +The marker is re-enabled either by setting visible to True, by +calling XtSetValues, or by executing the display-caret +action routine. + + + -- cgit v1.2.3