The DtEditor convenience functions are described in the following tables.
The DtEditor life cycle functions are described in Table 7-3 .
Table 7-3 DtEditor Life Cycle Functions
Function |
Description |
---|---|
DtCreateEditor |
Creates a new instance of a DtEditorwidget and its children. |
DtEditorReset |
Restores a DtEditor widget to its initial state. |
The DtEditor input/output functions are described in Table 7-4 .
Table 7-4 DtEditor Input/Output Functions
Function |
Description |
---|---|
DtEditorAppend |
Appends content data to the end of an editor widget. |
DtEditorAppendFromFile |
Appends the contents of a file to the end of an editor widget. |
DtEditorGetContents |
Retrieves the entire contents of an editor widget. |
DtEditorInsert |
Inserts content data at the current insert position. |
DtEditorInsertFromFile |
Inserts the contents of a file at the current insert position. |
DtEditorReplace |
Replaces a portion of text with the supplied data. |
DtEditorReplaceFromFile |
Replaces a portion of text with the contents of a file. |
DtEditorSaveContentsToFile |
Saves the entire contents to a file. |
DtEditorSetContents |
Loads content data into an editor widget, replacing the entire contents of the widget. |
DtEditorSetContentsFromFile |
Loads the contents of a file into an editor widget, replacing the entire contents of the widget. |
The DtEditor selection functions are described in Table 7-5 .
Table 7-5 DtEditor Selection Functions
Function |
Description |
---|---|
DtEditorClearSelection |
Replaces the currently selected contents with blanks. |
DtEditorCopyToClipboard |
Copies the currently selected contents to the clipboard. |
DtEditorCutToClipboard |
Removes the currently selected contents, placing then on the clipboard. |
DtEditorDeleteSelection |
Removes the currently selected contents. |
DtEditorDeselect |
Deselects any selected contents. |
DtEditorPasteFromClipboard |
Pastes the contents of the clipboard into an editor widget, replacing any currently selected contents. |
DtEditorSelectAll |
Selects the entire contents of an editor widget. |
The DtEditor format functions are described inTable 7-6 .
Table 7-6 DtEditor Format Functions
Function |
Description |
---|---|
DtEditorFormat |
Formats all or part of the contents of an editor widget. |
DtEditorInvokeFormatDialog |
Displays the format dialog box that enables the user to specify format settings for margins and justification style and to perform formatting operations. |
The DtEditor find and change functions are described in Table 7-7 .
Table 7-7 DtEditArea Find and Change Functions
Function |
Description |
---|---|
DtEditorChange |
Changes one or all occurrences of a string. |
DtEditorFind |
Finds the next occurrence of a string. |
DtEditorInvokeFindChangeDialog |
Displays the dialog box that enables the user to search for, and optionally change, a string. |
DtEditorInvokeSpellDialog |
Displays a dialog box with a list of misspelled words in the current contents. |
The DtEditor auxiliary functions are described in Table 7-8 .
Table 7-8 DtEditor Auxiliary Functions
Function |
Description |
---|---|
DtEditorCheckForUnsavedChanges |
Reports whether the contents of an editor widget have been altered since the last time they were retrieved or saved. |
DtEditorDisableRedisplay |
Prevents redisplay of an editor widget even though its visual attributes have changed. |
DtEditorEnableRedisplay |
Forces the visual update of an editor widget. |
DtEditorGetInsertPosition |
Returns the insertion cursor position of the editor widget. |
DtEditorGetLastPosition |
Returns the position of the last character in the edit window. |
DtEditorGetMessageTextFieldID |
Retrieves the widget ID of the text field widget used to display application messages. |
DtEditorGetSizeHints |
Retrieves sizing information from an editor widget. |
DtEditorGoToLine |
Moves the insertion cursor to the specified line. |
DtEditorSetInsertionPosition |
Sets the position of the insertion cursor. |
DtEditorTraverseToEditor |
Sets keyboard traversal to the edit window of an editor widget. |
DtEditorUndoEdit |
Undoes the last edit made by a user. |