XeText Functions

:Associate with "XeText Functions" More...

Defines
#define	XeTextGetStringUnicode   XeTextGetStringUC
#define	XeTextMakeCursorPositionVisible   XeTextMakeCursorPositionVisable
#define	XeTextSetStringUnicode   XeTextSetStringUC
Typedefs
typedef int(*	XeTextExtractFeed )(MIUNICODE *, int, XeTextTag, XtPointer)
Functions
void	_XeAdjustScrollBars (Widget)
void	_XeTextMarkSelection (Widget)
void	_XeTextPrepareToScrol (Widget)
void	_XeTextUpdateFromScro (Widget)
EDITMENU *	XeTextAddPopupEditMenu (Widget xetext)
void	XeTextCopy (Widget)
void	XeTextCut (Widget)
void	XeTextDisableDisplay ()
void	XeTextDisplay ()
_XFUNCPROTOBEGIN void	XeTextEnableDisplay ()
void	XeTextExtract (Widget, int, int, XeTextExtractFeed, XtPointer)
EDITMENU *	XeTextGetEditMenu (Widget xetext)
int	XeTextGetInsertionPoint ()
int	XeTextGetInsertionPosition (Widget)
XeTextTag	XeTextGetInsertionTag ()
int	XeTextGetLength (Widget, int)
void	XeTextGetSelectionPosition ()
MIUNICODE *	XeTextGetSelectionUC (Widget)
void	XeTextGetString (Widget xetext, MISTRING &string)
_XFUNCPROTOEND MISTRING	XeTextGetString (Widget xetext)
String	XeTextGetString (Widget, int *)
MIUNICODE *	XeTextGetStringUC (Widget)
const TEXTSTYLE &	XeTextGetStyle (Widget widget, int offset)
String	XeTextGetSubstring (Widget, int *, int, int)
void	XeTextInsert (Widget xetext, const MIUNICODE *string)
void	XeTextInsert (Widget xetext, const char *string)
void	XeTextInsert ()
void	XeTextInsertUnicode ()
void	XeTextKeyEventHandler (Widget, XtPointer, XEvent *, Boolean *)
void	XeTextMakeCursorPositionVisable (Widget, void *)
void	XeTextPaste (Widget)
void	XeTextRemove (Widget)
void	XeTextReplace (Widget, int, int, const char *, int)
void	XeTextReplaceTagged (Widget, int, int, const char *, int, XeTextTag)
void	XeTextReplaceTaggedUC (Widget, int, int, const MIUNICODE *, int, XeTextTag)
Boolean	XeTextSaveAsFile ()
int	XeTextScan ()
bool	XeTextScrollToAnchor (Widget, const MIUNICODE *anchor)
int	XeTextSearch ()
void	XeTextSetInsertionPosition (Widget, int)
void	XeTextSetSelection ()
void	XeTextSetString (Widget, const char *)
void	XeTextSetStringUC (Widget, const MIUNICODE *)
void	XeTextSetStyle (Widget widget, const TEXTSTYLEDIFF &style, int startoffset=-1, int endoffset=-1)
void	XeTextUnsetSelection ()

---

Detailed Description

:Associate with "XeText Functions"

---

Define Documentation

#define XeTextGetStringUnicode   XeTextGetStringUC

Old name.

#define XeTextMakeCursorPositionVisible   XeTextMakeCursorPositionVisable

#define XeTextSetStringUnicode   XeTextSetStringUC

Old name.

---

Typedef Documentation

typedef int(* XeTextExtractFeed)(MIUNICODE *,int,XeTextTag,XtPointer)

---

Function Documentation

void _XeAdjustScrollBars

(

Widget

)

void _XeTextMarkSelection

(

Widget

)

void _XeTextPrepareToScrol

(

Widget

)

void _XeTextUpdateFromScro

(

Widget

)

EDITMENU* XeTextAddPopupEditMenu

(

Widget

xetext

)

Add a popup menu with cut/copy/paste to an XeText widget.

void XeTextCopy

(

Widget

)

void XeTextCut

(

Widget

)

void XeTextDisableDisplay

(

)

void XeTextDisplay

(

)

_XFUNCPROTOBEGIN void XeTextEnableDisplay

(

)

void XeTextExtract	(	Widget	,
		int	,
		int	,
		XeTextExtractFeed	,
		XtPointer
	)

EDITMENU* XeTextGetEditMenu

(

Widget

xetext

)

Get the EDITMENU for this widget (assuming there is on).

int XeTextGetInsertionPoint

(

)

int XeTextGetInsertionPosition

(

Widget

)

XeTextTag XeTextGetInsertionTag

(

)

int XeTextGetLength	(	Widget	,
		int
	)

void XeTextGetSelectionPosition

(

)

MIUNICODE* XeTextGetSelectionUC

(

Widget

)

void XeTextGetString	(	Widget	xetext,
		MISTRING &	string
	)			[inline]

Copy contents of XeText widget into MISTRING.

Parameters:

	xetext	XeText widget
	string	String to contain result

_XFUNCPROTOEND MISTRING XeTextGetString

(

Widget

xetext

)

[inline]

Return contents of XeText widget as MISTRING.

Parameters:

xetext

XeText widget

String XeTextGetString	(	Widget	,
		int *
	)

MIUNICODE* XeTextGetStringUC

(

Widget

)

const TEXTSTYLE& XeTextGetStyle	(	Widget	widget,
		int	offset
	)

Get the text style at the given location.

Parameters:

offset

use -1 for current cursor location

String XeTextGetSubstring	(	Widget	,
		int *	,
		int	,
		int
	)

void XeTextInsert	(	Widget	xetext,
		const MIUNICODE *	string
	)			[inline]

Insert MIUNICODE string into XeText widget.

Parameters:

	xetext	XeText widget
	string	Unicode string to insert

void XeTextInsert	(	Widget	xetext,
		const char *	string
	)			[inline]

Insert char* string into XeText widget.

Parameters:

xetext

XeText widget

void XeTextInsert

(

)

void XeTextInsertUnicode

(

)

void XeTextKeyEventHandler	(	Widget	,
		XtPointer	,
		XEvent *	,
		Boolean *
	)

void XeTextMakeCursorPositionVisable	(	Widget	,
		void *
	)

void XeTextPaste

(

Widget

)

void XeTextRemove

(

Widget

)

void XeTextReplace	(	Widget	,
		int	,
		int	,
		const char *	,
		int
	)

void XeTextReplaceTagged	(	Widget	,
		int	,
		int	,
		const char *	,
		int	,
		XeTextTag
	)

void XeTextReplaceTaggedUC	(	Widget	,
		int	,
		int	,
		const MIUNICODE *	,
		int	,
		XeTextTag
	)

Boolean XeTextSaveAsFile

(

)

int XeTextScan

(

)

bool XeTextScrollToAnchor	(	Widget	,
		const MIUNICODE *	anchor
	)

Scroll to an anchor.

An anchor (which is hidden) is imbeded in the text stream as.. \033[5m@NAME\033[25m Where NAME is the name of the anchor.

Returns:

true if the anchor was found, false if not

int XeTextSearch

(

)

void XeTextSetInsertionPosition	(	Widget	,
		int
	)

void XeTextSetSelection

(

)

void XeTextSetString	(	Widget	,
		const char *
	)

void XeTextSetStringUC	(	Widget	,
		const MIUNICODE *
	)

void XeTextSetStyle	(	Widget	widget,
		const TEXTSTYLEDIFF &	style,
		int	startoffset = -1,
		int	endoffset = -1
	)

Set the text style at the given location TEXTSTYLEDIFF is derived from TEXTSTYLE, and contains flags saying which values to actually change.

GENERATING_DOXYGEN_OUTPUT __cplusplus

Parameters:

	style	Change
	startoffset	use -1 for current cursor selection
	endoffset	use -1 for current cursor selection

void XeTextUnsetSelection

(

)