Index Index for
Section 3
Index Alphabetical
listing for D
Bottom of page Bottom of
page		 

DtEditorChange(3)


CDE


NAME

  DtEditorChange - change one or all occurrences of a string in a DtEditor
  widget


SYNOPSIS

  #include <Editor.h>
  Boolean DtEditorChange(Widget widget,
  DtEditorChangeValues *findChangeStrings,
  unsigned int instanceToChange);


DESCRIPTION

  The DtEditorChange function replaces the next occurrence of a string, all
  occurrences of the string, or the currently selected text in a DtEditor
  widget with a replacement string. The string to search for and the value to
  change it to can be the last values entered in the Find/Change dialog (see
  DtEditorInvokeFindChangeDialog(3)) or passed as arguments to
  DtEditorChange.

  The search begins at the insertion cursor. If the string is not found by
  the time the end of the document is reached, the search continues at the
  beginning of the document, stopping at the character before the insertion
  cursor.

  The widget argument specifies the DtEditor widget ID.

  The findChangeStrings argument specifies the string to change and the
  replacement value. If findChangeStrings is NULL, DtEditorChange uses the
  last string specified in the Find and Change To fields of the Find/Change
  dialog. If the instanceToChange argument is DtEDITOR_CURRENT_SELECTION, the
  Find field of DtEditorChangeValues is ignored.

  If the instanceToChange argument is set to DtEDITOR_NEXT_OCCURRENCE,
  DtEditorChange replaces the next occurrence (relative to the insertion
  cursor) of the find string.  If this argument is set to
  DtEDITOR_ALL_OCCURRENCES, all instances of the find string are changed. If
  this argument ia set to DtEDITOR_CURRENT_SELECTION, the Find field of
  DtEditorChangeValues, is ignored and the currently selected text is
  replaced.

  For a complete definition of the DtEditor widget and its associated
  resources, see DtEditor(3).

  For a complete definition of DtEditorChangeValues, see Editor.h(5).


RETURN VALUE

  Upon successful completion, the DtEditorChange function returns True if the
  substitution occurred; otherwise, it returns False.


SEE ALSO

  Editor.h(5), DtEditor(3), DtEditorFind(3),
  DtEditorInvokeFindChangeDialog(3)

Index Index for
Section 3
Index Alphabetical
listing for D
Top of page Top of
page