<HTML><HEAD><TITLE>Manpage of XmText</TITLE>
</HEAD><BODY>
<H1>XmText</H1>
Section: LessTif Manuals (3)<BR>Updated: April 1998<BR><A HREF="#index">Index</A>
<BR><A HREF="lesstif.html">Return to Main Contents</A>
<HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

XmText
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>#include &lt;<A HREF="include/Xm/Text.h">Xm/Text.h</A>&gt;</B>

<P>

<B>XmText</B>

<P>

<B>XmCreateText</B>

<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

XmText
<A NAME="lbAE">&nbsp;</A>
<H2>X RESOURCES</H2>

<TABLE>
<TR VALIGN=top><TD>Name</TD><TD>Class</TD><TD>Type</TD><TD>Default</TD><TD>Access<BR></TD></TR>
<TR VALIGN=top><TD COLSPAN=5><HR></TD></TR>
<TR VALIGN=top><TD>XmNsource</TD><TD>XmCSource</TD><TD>Pointer</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNactivateCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNfocusCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNlosingFocusCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNvalueChangedCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmodifyVerifyCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmodifyVerifyCallbackWcs</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmotionVerifyCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNgainPrimaryCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNlosePrimaryCallback</TD><TD>XmCCallback</TD><TD>Callback</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNvalue</TD><TD>XmCValue</TD><TD>String</TD><TD></TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNvalueWcs</TD><TD>XmCValueWcs</TD><TD>ValueWcs</TD><TD>(null)</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmaxLength</TD><TD>XmCMaxLength</TD><TD>Int</TD><TD>2147483647</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmarginHeight</TD><TD>XmCMarginHeight</TD><TD>VerticalDimension</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNmarginWidth</TD><TD>XmCMarginWidth</TD><TD>HorizontalDimension</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNoutputCreate</TD><TD>XmCOutputCreate</TD><TD>Function</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNinputCreate</TD><TD>XmCInputCreate</TD><TD>Function</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNtopCharacter</TD><TD>XmCTopCharacter</TD><TD>TextPosition</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNcursorPosition</TD><TD>XmCCursorPosition</TD><TD>TextPosition</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNeditMode</TD><TD>XmCEditMode</TD><TD>EditMode</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNautoShowCursorPosition</TD><TD>XmCAutoShowCursorPosition</TD><TD>Boolean</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNeditable</TD><TD>XmCEditable</TD><TD>Boolean</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNverifyBell</TD><TD>XmCVerifyBell</TD><TD>Boolean</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNshadowThickness</TD><TD>XmCShadowThickness</TD><TD>HorizontalDimension</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNhighlightThickness</TD><TD>XmCHighlightThickness</TD><TD>HorizontalDimension</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
<TR VALIGN=top><TD>XmNnavigationType</TD><TD>XmCNavigationType</TD><TD>NavigationType</TD><TD>NULL</TD><TD>CSG<BR></TD></TR>
</TABLE>

<P>

<B>XmNsource</B>

<P>

<B>XmNactivateCallback</B>

<P>

<B>XmNfocusCallback</B>

<P>

<B>XmNlosingFocusCallback</B>

<P>

<B>XmNvalueChangedCallback</B>

<P>

<B>XmNmodifyVerifyCallback</B>

<P>

<B>XmNmodifyVerifyCallbackWcs</B>

<P>

<B>XmNmotionVerifyCallback</B>

<P>

<B>XmNgainPrimaryCallback</B>

<P>

<B>XmNlosePrimaryCallback</B>

<P>

<B>XmNvalue</B>

<P>

<B>XmNvalueWcs</B>

<P>

<B>XmNmaxLength</B>

<P>

<B>XmNmarginHeight</B>

<P>

<B>XmNmarginWidth</B>

<P>

<B>XmNoutputCreate</B>

<P>

<B>XmNinputCreate</B>

<P>

<B>XmNtopCharacter</B>

<P>

<B>XmNcursorPosition</B>

<P>

<B>XmNeditMode</B>

<P>

<B>XmNautoShowCursorPosition</B>

<P>

<B>XmNeditable</B>

<P>

<B>XmNverifyBell</B>

<P>

<B>XmNshadowThickness</B>

<P>

<B>XmNhighlightThickness</B>

<P>

<B>XmNnavigationType</B>

<P>

<A NAME="lbAF">&nbsp;</A>
<H2>CLASS HIERARCHY</H2>

<B><A HREF="Object.html">Object</A></B>(3)

<B><A HREF="Rect.html">Rect</A></B>(3)

<B><A HREF="UnNamedObj.html">UnNamedObj</A></B>(3)

<B><A HREF="Core.html">Core</A></B>(3)

<B><A HREF="XmPrimitive.html">XmPrimitive</A></B>(3)

<B><A HREF="XmText.html">XmText</A></B>(3)

<A NAME="lbAG">&nbsp;</A>
<H2>CALLBACKS</H2>

The XmText widget defines a large number of callback lists :
<B>XmNactivateCallback</B>,

<B>XmNfocusCallback</B>,

<B>XmNlosingFocusCallback</B>,

<B>XmNvalueChangedCallback</B>,

<B>XmNmodifyVerifyCallback</B>,

<B>XmNmodifyVerifyCallbackWcs</B>,

<B>XmNmotionVerifyCallback</B>,

<B>XmNgainPrimaryCallback</B>,

<B>XmNlosePrimaryCallback</B>.

The XmNactivateCallback can only be called
if the XmNeditMode is XmSINGLE_LINE_EDIT.
<FONT SIZE=-1><BR>&nbsp;&nbsp;typedef&nbsp;struct&nbsp;{</FONT>
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;reason;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XEvent&nbsp;*event;&nbsp;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean&nbsp;doit;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextPosition&nbsp;currInsert,&nbsp;newInsert;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextPosition&nbsp;startPos,&nbsp;endPos;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextBlock&nbsp;text;
<BR>&nbsp;&nbsp;}&nbsp;XmTextVerifyCallbackStruct,&nbsp;*XmTextVerifyPtr;
<BR>&nbsp;&nbsp;
<BR>&nbsp;&nbsp;typedef&nbsp;struct&nbsp;{
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;char&nbsp;*ptr;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;length;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextFormat&nbsp;format;
<BR>&nbsp;&nbsp;}&nbsp;XmTextBlockRec,&nbsp;*XmTextBlock;
<BR>&nbsp;&nbsp;
<BR>&nbsp;&nbsp;typedef&nbsp;struct&nbsp;{
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;wchar_t&nbsp;*wcsptr;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;length;
<BR>&nbsp;&nbsp;}&nbsp;XmTextBlockRecWcs,&nbsp;*XmTextBlockWcs;
<BR>&nbsp;&nbsp;
<BR>&nbsp;&nbsp;typedef&nbsp;struct&nbsp;{
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;reason;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XEvent&nbsp;*event;&nbsp;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Boolean&nbsp;doit;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextPosition&nbsp;currInsert,&nbsp;newInsert;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextPosition&nbsp;startPos,&nbsp;endPos;
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XmTextBlockWcs&nbsp;text;
<BR>&nbsp;&nbsp;}&nbsp;XmTextVerifyCallbackStructWcs,&nbsp;*XmTextVerifyPtrWcs;
<FONT SIZE=-1></FONT><A NAME="lbAH">&nbsp;</A>
<H2>ACTIONS</H2>


<TABLE>
<TR VALIGN=top><TD>activate()<BR></TD></TR>
<TR VALIGN=top><TD>backward-character()<BR></TD></TR>
<TR VALIGN=top><TD>backward-paragraph()<BR></TD></TR>
<TR VALIGN=top><TD>backward-word()<BR></TD></TR>
<TR VALIGN=top><TD>beep()<BR></TD></TR>
<TR VALIGN=top><TD>beginning-of-file()<BR></TD></TR>
<TR VALIGN=top><TD>beginning-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>clear-selection()<BR></TD></TR>
<TR VALIGN=top><TD>copy-clipboard()<BR></TD></TR>
<TR VALIGN=top><TD>copy-primary()<BR></TD></TR>
<TR VALIGN=top><TD>copy-to()<BR></TD></TR>
<TR VALIGN=top><TD>cut-clipboard()<BR></TD></TR>
<TR VALIGN=top><TD>cut-primary()<BR></TD></TR>
<TR VALIGN=top><TD>delete-next-character()<BR></TD></TR>
<TR VALIGN=top><TD>delete-previous-character()<BR></TD></TR>
<TR VALIGN=top><TD>delete-next-word()<BR></TD></TR>
<TR VALIGN=top><TD>delete-previous-word()<BR></TD></TR>
<TR VALIGN=top><TD>delete-selection()<BR></TD></TR>
<TR VALIGN=top><TD>delete-to-end-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>delete-to-start-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>delete-all()<BR></TD></TR>
<TR VALIGN=top><TD>do-quick-action()<BR></TD></TR>
<TR VALIGN=top><TD>end-of-file()<BR></TD></TR>
<TR VALIGN=top><TD>end-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>extend-adjust()<BR></TD></TR>
<TR VALIGN=top><TD>extend-end()<BR></TD></TR>
<TR VALIGN=top><TD>extend-start()<BR></TD></TR>
<TR VALIGN=top><TD>forward-character()<BR></TD></TR>
<TR VALIGN=top><TD>forward-paragraph()<BR></TD></TR>
<TR VALIGN=top><TD>forward-word()<BR></TD></TR>
<TR VALIGN=top><TD>focus-in()<BR></TD></TR>
<TR VALIGN=top><TD>focus-out()<BR></TD></TR>
<TR VALIGN=top><TD>grab-focus()<BR></TD></TR>
<TR VALIGN=top><TD>Help()<BR></TD></TR>
<TR VALIGN=top><TD>insert-string()<BR></TD></TR>
<TR VALIGN=top><TD>key-select()<BR></TD></TR>
<TR VALIGN=top><TD>kill-next-character()<BR></TD></TR>
<TR VALIGN=top><TD>kill-next-word()<BR></TD></TR>
<TR VALIGN=top><TD>kill-previous-character()<BR></TD></TR>
<TR VALIGN=top><TD>kill-previous-word()<BR></TD></TR>
<TR VALIGN=top><TD>kill-selection()<BR></TD></TR>
<TR VALIGN=top><TD>kill-to-end-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>kill-to-start-of-line()<BR></TD></TR>
<TR VALIGN=top><TD>move-destination()<BR></TD></TR>
<TR VALIGN=top><TD>move-to()<BR></TD></TR>
<TR VALIGN=top><TD>newline()<BR></TD></TR>
<TR VALIGN=top><TD>newline-and-backup()<BR></TD></TR>
<TR VALIGN=top><TD>newline-and-indent()<BR></TD></TR>
<TR VALIGN=top><TD>next-line()<BR></TD></TR>
<TR VALIGN=top><TD>next-page()<BR></TD></TR>
<TR VALIGN=top><TD>next-tab-group()<BR></TD></TR>
<TR VALIGN=top><TD>page-left()<BR></TD></TR>
<TR VALIGN=top><TD>page-right()<BR></TD></TR>
<TR VALIGN=top><TD>paste-clipboard()<BR></TD></TR>
<TR VALIGN=top><TD>prev-tab-group()<BR></TD></TR>
<TR VALIGN=top><TD>previous-line()<BR></TD></TR>
<TR VALIGN=top><TD>previous-page()<BR></TD></TR>
<TR VALIGN=top><TD>process-bdrag()<BR></TD></TR>
<TR VALIGN=top><TD>process-cancel()<BR></TD></TR>
<TR VALIGN=top><TD>process-down()<BR></TD></TR>
<TR VALIGN=top><TD>process-up()<BR></TD></TR>
<TR VALIGN=top><TD>process-home()<BR></TD></TR>
<TR VALIGN=top><TD>process-return()<BR></TD></TR>
<TR VALIGN=top><TD>process-shift_down()<BR></TD></TR>
<TR VALIGN=top><TD>process-shift-up()<BR></TD></TR>
<TR VALIGN=top><TD>process-tab()<BR></TD></TR>
<TR VALIGN=top><TD>quick-copy-set()<BR></TD></TR>
<TR VALIGN=top><TD>quick-cut-set()<BR></TD></TR>
<TR VALIGN=top><TD>redraw-display()<BR></TD></TR>
<TR VALIGN=top><TD>scroll-one-line-down()<BR></TD></TR>
<TR VALIGN=top><TD>scroll-one-line-up()<BR></TD></TR>
<TR VALIGN=top><TD>secondary-adjust()<BR></TD></TR>
<TR VALIGN=top><TD>secondary-notify()<BR></TD></TR>
<TR VALIGN=top><TD>secondary-start()<BR></TD></TR>
<TR VALIGN=top><TD>select-adjust()<BR></TD></TR>
<TR VALIGN=top><TD>select-all()<BR></TD></TR>
<TR VALIGN=top><TD>select-end()<BR></TD></TR>
<TR VALIGN=top><TD>select-start()<BR></TD></TR>
<TR VALIGN=top><TD>self-insert()<BR></TD></TR>
<TR VALIGN=top><TD>set-anchor()<BR></TD></TR>
<TR VALIGN=top><TD>set-insertion-point()<BR></TD></TR>
<TR VALIGN=top><TD>set-selection-hint()<BR></TD></TR>
<TR VALIGN=top><TD>toggle-add-mode()<BR></TD></TR>
<TR VALIGN=top><TD>traverse-home()<BR></TD></TR>
<TR VALIGN=top><TD>traverse-next()<BR></TD></TR>
<TR VALIGN=top><TD>traverse-prev()<BR></TD></TR>
<TR VALIGN=top><TD>unkill()<BR></TD></TR>
</TABLE>

<A NAME="lbAI">&nbsp;</A>
<H2>CONVENIENCE FUNCTIONS</H2>

<B>XmTextClearSelection(Widget w,Time time)</B>

<P>

Clears the primary selection from the Text Widget.
<P>

<B>Boolean XmTextCopy(Widget w,Time time)</B>

<P>

Copies the primary selection from the Text Widget to the Clipboard.
<P>

<B>Boolean XmTextCut(Widget w,Time time)</B>

<P>

Copies the primary selection from the Text Widget to the Clipboard and deletes it from the Text Widget.
<P>

<B>int XmTextGetBaseline(Widget w)</B>

<P>

Gets the X position of the first baseline in the Text Widget.
<P>

<B>Boolean XmTextGetEditable(Widget w)</B>

<P>

Determine the Editable permission state.
<P>

<B>XmTextPosition XmTextGetInsertionPositiom(Widget w)</B>

<P>

Determine the insertion position of the cursor.
<P>

<B>XmTextPosition XmTextGetLastPosition(Widget w)</B>

<P>

Determine the position of the last character in the Text Widget.
<P>

<B>int XmTextGetMaxLength(Widget w)</B>

<P>

Determine the maximum allowable text string length. 
<P>

<B>char *XmTextGetSelection(Widget w)</B>

<P>

Gets the string that is in the primary selection. 
<P>

<B>Boolean XmTextGetSelectionPosition(Widget w,XmTextPosition *left,XmTextPosition *right)</B>

<P>

Accesses the position of the Lest and Right position of the primary position.
<P>

<B>XmTextSource XmTextGetSource(Widget w)</B>

<P>

obtain the source of the Text Widget. 
<P>

<B>char *XmTextGetString(Widget w)</B>

<P>

Obtain the text from the Text Widget. 
<P>

<B>XmTextPosition XmTextGetTopCharacter(Widget w)</B>

<P>

Determine the position of the top of the text in the Text Widget.
<P>

<B>void XmTextInsert(Widget w,XmTextPosition pos ,char *value)</B>

<P>

Insert a string into the text string at a position determined by pos.
<P>

<B>Boolean XmTextPaste(Widget w)</B>

<P>

Insert the clipboard selection into the Text Widget.
<P>

<B>Boolean XmTextPosToXY(Widget w,XmTextPosition pos, Position *x,Position *y)</B>

<P>

Converts a TextPosition into a x,y position.
<P>

<B>Boolean XmTextRemove(Widget w)</B>

<P>

Deletes the primary selection.
<P>

<B>void XmTextReplace(Widget w,XmTextPosition a,XmTextPosition b,char *value)</B>

<P>

Replace the text from a to b with that given in value.
<P>

<B>void XmTextScroll(Widget w,int num_of_lines)</B>

<P>

Scroll the TextWidget num_of_lines.
<P>

<B>void XmTextSetAddMode(Widget w,Boolean state)</B>

<P>

Sets the Add Mode state of the Text Widget.
<P>

<B>void XmTextSetEditable(Widget w,Boolean state)</B>

<P>

Sets the Editable state of the Text Widget.
<P>

<B>void XmTextSetHighlight(Widget w,XmTextPosition left,XmTextPosition right, XmHighLightMode mode)</B>

<P>

Highlights the text between the two positions. 
<P>

<B>void XmTextSetInsertionPosition(Widget w,XmTextPosition pos)</B>

<P>

Set the position of the insertion cursor.
<P>

<B>void XmTextSetMaxLength(Widget w,int max_length)</B>

<P>

Set the maximum length of the text string of the text widget.
<P>

<B>void XmTextSetSelection(Widget w,XmTextPosition first,XmTextPosition last,Time time)</B>

<P>

Set the primary selection of of the text widget.
<P>

<B>void XmTextSetSource(Widget w,XmTextSource source,XmTextPosition top_char,XmTextPosition cursor_pos)</B>

<P>

Set the text source for the text widget.
<P>

<B>void XmTextSetString(Widget w,char *value)</B>

<P>

Set the String value.
<P>

<B>void XmTextSetTopCharacter(Widget w,XmTextPosition top_character)</B>

<P>

Sets the position of the first character displayed.
<P>

<B>void XmTextShowPosition(Widget w,XmTextPosition)</B>

<P>

Show the text at a given position.
<P>

<B>XmTextPosition XmTextXYToPos(Widget w,Position x,Position y)</B>

<P>

Converts an X,Y position into an XmTextPosition.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>

<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">X RESOURCES</A><DD>
<DT><A HREF="#lbAF">CLASS HIERARCHY</A><DD>
<DT><A HREF="#lbAG">CALLBACKS</A><DD>
<DT><A HREF="#lbAH">ACTIONS</A><DD>
<DT><A HREF="#lbAI">CONVENIENCE FUNCTIONS</A><DD>
<DT><A HREF="#lbAJ">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://www.debian.org/Packages/unstable/doc/man2html.html">man2html</A>,
using the manual pages.<BR>
Time: 22:45:33 GMT, January 14, 2000
</BODY>
</HTML>
