Methods Index

NTextEdit

Heritage

Superclass: CNativeTextEdit

Subclasses: NScrollText

Public Methods

Constructor, Destructor, and Initializer Methods

NTextEdit(CSubview* theEnclosure,
	const CRect& theRegion,
	unsigned theAttributes	= TX_BORDER,
	int theRightMargin	= 1000,
	int theCharacterLimit	= 1000);

A constructor. theEnclosure is a pointer to the subview that will contain the text box. theRegion is a coordinate location, local to the enclosure, that is used to place the text box. If the text box has a border, which is the default, then the border rectangle is drawn around the CRect. This CRect object is inset by 4 pixels inside the border. The bottom of the CRect may be inset even more to ensure that an integral number of lines will fit into the text box.

In addition, this constructor takes an unsigned value pertaining to the XVT attributes that the text edit system can have. These attributes can be OR'd and passed in together, as described in the text editing chapter of the XVT Portability Toolkit Guide. For further information on the possible values for theAttributes, see Table 10 .

Finally, this constructor takes a right margin for the text box, which is measured in pixels starting with zero (0) at the left side of the text box, and a limit on the number of characters that can fit into the text box.

NTextEdit(const NTextEdit& theTextEdit);

A copy constructor that duplicates the attributes of a text box, as well as the text inside it.

NTextEdit& operator=(const NTextEdit& theTextEdit);

An assignment operator that duplicates the attributes of a text box, as well as the text inside it.

virtual ~NTextEdit();

The destructor, which cleans up the text edit system.

BOOLEAN ITextEdit(
	unsigned theAttributes	= TX_BORDER,
	int theRightMargin 	= 1000,
	int theCharacterLimit 	= 1000,
	const CStringRW theInitialText	= NULLString,
	BOOLEAN isAutoSelected 	= FALSE,
	BOOLEAN isVisible 	= TRUE,
	long theGlue 	= NULLSTICKY);

The initializer. It is identical to the initializer of CNativeTextEdit. It takes an unsigned value pertaining to the XVT attributes that the text edit system can have. These attributes can be OR'd and passed in together, as described in the text editing chapter of the XVT Portability Toolkit Guide. For further information on the possible values for theAttributes, see

Table 10

The next parameter, theRightMargin is a pixel measurement of the right margin, starting from the left side and beginning at zero (0). In addition, there is a parameter that sets the default character limit at 1,000 characters. theInitialText is a string containing any text you may wish to initialize with the text edit system. If the isAutoSelected parameter is set to TRUE, all of the text in the text edit box becomes selected when the user clicks inside the box. Finally, this initializer, like the initializers of all CView classes, takes a visibility state and a glue type.

Caret Interface

void GetInsertPosition(T_PNUM* thePar, 
	T_LNUM* theLine, T_CNUM* theChar) const;

This method allows the user to get the current insertion point position. thePar is the paragraph the cursor is in. theLine is the line within the paragraph. theChar is the character position within the line of the paragraph.

void SetInsertPosition(T_PNUM thePar, 
	T_LNUM theLine, T_CNUM theChar);

This method allows the user to set the insertion point position. thePar is the paragraph the cursor is to be placed. theLine is the line within the paragraph. theChar is the character position within the line of the paragraph.

Paragraph Methods

virtual BOOLEAN SetParagraph(
	const CStringRW& theText, T_PNUM theParagraph);

Sets a paragraph. This method takes a string buffer and a paragraph number. The paragraph number must be a valid, existing paragraph number.

virtual BOOLEAN AddParagraph(
	const CStringRW& theText, T_PNUM theParagraph);

Adds a paragraph to a text box. It takes a string buffer and a new paragraph number. If (theParagraph==USHRT_MAX), the paragraph is added at the end of the text.

virtual BOOLEAN AppendToParagraph(
	const CStringRW& theText, T_PNUM theParagraph);

Appends a paragraph to a text box. It takes a string buffer and a paragraph number. The paragraph number must be a valid, existing paragraph number.

virtual BOOLEAN DeleteParagraph(T_PNUM theParagraph);

Removes the paragraph designated by theParagraph from the text box. Numbering of paragraphs starts at zero. This method returns TRUE if the paragraph is successfully deleted.

virtual CStringRW GetParagraph(
	T_PNUM theParagraph) const;

Given a paragraph number, GetParagraph returns the designated paragraph.

virtual void SelectParagraph(T_PNUM theParagraph, 
	T_LNUM theStartLine	= 0, 
	T_LNUM theEndLine	= LAST,	
	T_CNUM theStartChar	= 0, 
	T_CNUM theEndChar	= LAST);

Selects a paragraph within a text box. This method takes a paragraph number, the numbers of the first and last lines in the paragraph, and the numbers of the starting and ending characters in the paragraph.

virtual T_CNUM GetNCharInPar(
	T_PNUM theParagraph) const;

Given a paragraph number, returns the total number of characters in that paragraph.

virtual T_PNUM GetNParInText(void) const;

Returns the total number of paragraphs inside a text box.

virtual T_PNUM GetNParInSelection(void) const;

Returns the total number of paragraphs in the selected text.

Line Methods

virtual void SetLine(const CStringRW& theText, 
	T_PNUM theParagraph, T_LNUM theLine);

Sets a line within a paragraph. This method takes a string buffer, a paragraph number, and a line number. Both the paragraph number and the line number must be valid, existing numbers.

virtual CStringRW GetLine(T_PNUM theParagraph, 
	T_LNUM theLine) const;

Given a paragraph number and a line number, GetLine returns the designated line.

virtual void SelectLine(
	T_LNUM theLine	= 0, 
	T_PNUM theParagraph	= 0, 
	T_CNUM theStartingChar	= 0, 
	T_CNUM theEndingChar	= LAST);

Selects a line of text. This method takes a line number (starting at zero (0) from the top of the text box), a paragraph number, and numbers for the starting and ending characters.

virtual T_CNUM GetNCharInLine(
	T_PNUM theParagraph=0, T_LNUM theLine=0) const;

Given a paragraph number and a line number, this method returns the total number of characters in the line.

virtual T_LNUM GetNLineInPar(T_PNUM theParagraph) const;

Given a paragraph number, this method returns the total number of lines in that paragraph.

virtual T_LNUM GetNLineInText(void) const;

Returns the total number of lines contained in a text box.

virtual T_LNUM GetNLineInSelection(void) const;

Returns the total number of lines contained in the selected text.

Partial Text Utility

virtual CStringRW GetSomeText(
	T_PNUM theStartParagraph,
	T_PNUM theEndParagraph,
	T_LNUM theStartLine,
	T_LNUM theEndLine,
	T_CNUM theStartChar,
	T_CNUM theEndChar);

Returns a requested body of text. GetSomeText takes the numbers of the starting and ending paragraphs, the numbers of the starting and ending lines, and the numbers of the starting and ending characters.

virtual void SelectSomeText(
	T_PNUM theStartParagraph,
	T_PNUM theEndParagraph,
	T_LNUM theStartLine,
	T_LNUM theEndLine,
	T_CNUM theStartChar,
	T_CNUM theEndChar);

Selects a specified body of text. This method takes the numbers of the starting and ending paragraphs, the numbers of the starting and ending lines, and the numbers of the starting and ending characters.

Protected Methods

NTextEdit(CSubview* theEnclosure);

This is a copy constructor used for slow initialization.

[Classes] [Prev] [Next] [Methods]

support@xvt.com

NTextEdit

NTextEdit

Heritage

Description

Usage

Environment

Public Methods

Constructor, Destructor, and Initializer Methods

Caret Interface

Paragraph Methods

Line Methods

Partial Text Utility

Protected Methods