cde/doc/C/guides/man/man5/DtEditor.sgm

   1 <!-- $XConsortium: DtEditor.sgm /main/8 1996/09/08 19:59:04 rws $ -->
   2 <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
   3 <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
   4 <!-- (c) Copyright 1995 International Business Machines Corp. -->
   5 <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
   6 <!-- (c) Copyright 1995 Novell, Inc. -->
   7 <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
   8 <!-- (c) Copyright 1995 Hitachi. -->
   9
  10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN73.rsml.1">]]>
  11 <![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN73.rsml.1">]]>
  12 <RefMeta>
  13 <RefEntryTitle>Dt/Editor.h</RefEntryTitle>
  14 <ManVolNum>file formats</ManVolNum>
  15 </RefMeta>
  16 <RefNameDiv>
  17 <RefName><Filename>Dt/Editor.h</Filename></RefName>
  18 <RefPurpose>editor widget definitions
  19 </RefPurpose>
  20 </RefNameDiv>
  21 <!-- CDE Common Source Format, Version 1.0.0-->
  22 <!-- *************************************************************************-->
  23 <!-- **  (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
  24 <!-- **  (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
  25 <!-- **  (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
  26 <!-- **  (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
  27 <!-- *************************************************************************-->
  28 <RefSynopsisDiv>
  29 <Synopsis>#include &lt;Dt/Editor.h>
  30 </Synopsis>
  31 </RefSynopsisDiv>
  32 <RefSect1>
  33 <Title>DESCRIPTION</Title>
  34 <Para>The
  35 <Filename Role="Header">Dt/Editor.h</Filename> header defines structures, enumerations and function prototypes for
  36 the Editor widget class.
  37 </Para>
  38 <Para>The header defines the
  39 <StructName Role="typedef">DtEditorDataFormat</StructName> enumeration data type,
  40 with at least the following members:
  41 </Para>
  42 <VariableList>
  43 <VarListEntry>
  44 <Term>DtEDITOR_TEXT</Term>
  45 <ListItem>
  46 <Para>The data being transferred is a pointer
  47 to a
  48 <SystemItem Class="Constant">NULL</SystemItem>&minus;terminated string of characters (a <StructName Role="typedef">char *</StructName>).
  49 </Para>
  50 </ListItem>
  51 </VarListEntry>
  52 <VarListEntry>
  53 <Term>DtEDITOR_WCHAR</Term>
  54 <ListItem>
  55 <Para>The data being transferred is a
  56 wide character string (a <StructName Role="typedef">wchar_t *</StructName>).
  57 </Para>
  58 </ListItem>
  59 </VarListEntry>
  60 <VarListEntry>
  61 <Term>DtEDITOR_DATA</Term>
  62 <ListItem>
  63 <Para>The data being transferred is a
  64 sized buffer (a
  65 <StructName Role="typedef">DtEditor_DataObj</StructName>).</Para>
  66 </ListItem>
  67 </VarListEntry>
  68 </VariableList>
  69 <Para>The header defines the following structure:
  70 </Para>
  71 <InformalExample Remap="indent">
  72 <ProgramListing>typedef struct {
  73         unsigned int <Symbol Role="Variable">length</Symbol>;
  74         void *<Emphasis>buf</Emphasis>;
  75 } DtEditor_DataObj;
  76 </ProgramListing>
  77 </InformalExample>
  78 <Para>The
  79 <Symbol Role="Variable">length</Symbol> argument is the
  80 size in bytes of the data buffer.
  81 The
  82 <Emphasis>buf</Emphasis> argument is a
  83 pointer to the data buffer.
  84 </Para>
  85 <Para>The
  86 <StructName Role="typedef">DtEditorContentRec</StructName> structure is used to transfer data between
  87 an application and Editor widget.
  88 It indicates the type of data being
  89 transferred along with the actual data.
  90 </Para>
  91 <InformalExample Remap="indent">
  92 <ProgramListing>typedef struct {
  93         DtEditorDataFormat <Symbol Role="Variable">type</Symbol>;
  94         union {
  95                 char <Emphasis>*string</Emphasis>;
  96                 wchar_t <Emphasis>*wchar</Emphasis>;
  97                 DtEditor_DataObj <Symbol Role="Variable">data</Symbol>;
  98         } <Symbol Role="Variable">value</Symbol>;
  99 } DtEditorContentRec;
 100 </ProgramListing>
 101 </InformalExample>
 102 <Para>The
 103 <Symbol Role="Variable">type</Symbol> argument
 104 indicates the type of data contained in the structure.
 105 The
 106 <Symbol Role="Variable">string</Symbol> argument
 107 points to a
 108 <SystemItem Class="Constant">NULL</SystemItem>&minus;terminated string of characters.
 109 It is valid when
 110 <Symbol Role="Variable">type</Symbol> is
 111 <SystemItem Class="Constant">DtEDITOR_TEXT</SystemItem>. The
 112 <Emphasis>wchar</Emphasis> argument
 113 points to a wide character string.
 114 It is valid when
 115 <Symbol Role="Variable">type</Symbol> is
 116 <SystemItem Class="Constant">DtEDITOR_WCHAR</SystemItem>. The
 117 <Symbol Role="Variable">data</Symbol> argument
 118 is a
 119 <StructName Role="typedef">DtEditor_DataObj</StructName> that contains the size of the
 120 data and a pointer to it.
 121 It is valid when
 122 <Symbol Role="Variable">type</Symbol> is
 123 <SystemItem Class="Constant">DtEDITOR_DATA</SystemItem>.</Para>
 124 <Para>The
 125 <StructName Role="typedef">DtEditorChangeValues</StructName> structure is used optionally to specify
 126 the string to search for and its replacement value for
 127 &cdeman.DtEditorChange;.</Para>
 128 <InformalExample Remap="indent">
 129 <ProgramListing>typedef struct {
 130         char *<Emphasis>find</Emphasis>,
 131         char *<Emphasis>changeTo</Emphasis>,
 132 } DtEditorChangeValues;
 133 </ProgramListing>
 134 </InformalExample>
 135 <Para>The
 136 <Emphasis>find</Emphasis> argument
 137 is a text string to locate in an DtEditor widget.
 138 The
 139 <Emphasis>changeTo</Emphasis> argument
 140 is the replacement string for the one or more occurrences of the string
 141 specified in
 142 <Emphasis>find</Emphasis>. It can be
 143 <SystemItem Class="Constant">NULL</SystemItem>.</Para>
 144 <Para>The
 145 <StructName Role="typedef">DtEditorFormatSettings</StructName> structure is used to optionally specify
 146 the left margin setting, right margin setting, and alignment style for
 147 &cdeman.DtEditorFormat;.</Para>
 148 <InformalExample Remap="indent">
 149 <ProgramListing>typedef struct {
 150         int <Emphasis>leftMargin</Emphasis>,
 151         int <Emphasis>rightMargin</Emphasis>,
 152         unsigned int <Symbol Role="Variable">alignment</Symbol>,
 153 } DtEditorFormatSettings;
 154 </ProgramListing>
 155 </InformalExample>
 156 <Para>The
 157 <Emphasis>leftMargin</Emphasis> argument
 158 is the column number of the left boundary when formatting text.
 159 Text is not extended to the left of this column.
 160 It must be non-negative.
 161 The
 162 <Emphasis>rightMargin</Emphasis> argument
 163 is the column number of the right boundary when formatting text.
 164 Text is not extended to the right of this column.
 165 It must be larger than
 166 <Emphasis>leftMargin</Emphasis>. The
 167 <Symbol Role="Variable">alignment</Symbol> argument
 168 specifies the style of alignment when formatting text (see the
 169 constants listed in this header).
 170 </Para>
 171 <Para>The
 172 header declares the following variable:
 173 </Para>
 174 <InformalExample Remap="indent">
 175 <ProgramListing>WidgetClass      dtEditorWidgetClass;
 176 </ProgramListing>
 177 </InformalExample>
 178 <Para>The
 179 header defines the following constants for use with the
 180 &cdeman.DtEditorChange; function:
 181 </Para>
 182 <VariableList>
 183 <VarListEntry>
 184 <Term>DtEDITOR_ALL_OCCURRENCES</Term>
 185 <ListItem>
 186 <Para>Change all instances of the find string.
 187 </Para>
 188 </ListItem>
 189 </VarListEntry>
 190 <VarListEntry>
 191 <Term>DtEDITOR_CURRENT_SELECTION</Term>
 192 <ListItem>
 193 <Para>Replace the currently selected text with the replacement string.
 194 </Para>
 195 </ListItem>
 196 </VarListEntry>
 197 <VarListEntry>
 198 <Term>DtEDITOR_NEXT_OCCURRENCE</Term>
 199 <ListItem>
 200 <Para>Change the next occurrence of the find string after the insertion
 201 cursor.
 202 </Para>
 203 </ListItem>
 204 </VarListEntry>
 205 </VariableList>
 206 <Para>The
 207 header defines the following constants for use with the
 208 &cdeman.DtEditorFormat; function:
 209 </Para>
 210 <VariableList>
 211 <VarListEntry>
 212 <Term>DtEDITOR_FORMAT_ALL</Term>
 213 <ListItem>
 214 <Para>Reformats all the text in a DtEditor.
 215 </Para>
 216 </ListItem>
 217 </VarListEntry>
 218 <VarListEntry>
 219 <Term>DtEDITOR_FORMAT_PARAGRAPH</Term>
 220 <ListItem>
 221 <Para>Reformats only the paragraph containing the insertion cursor.
 222 </Para>
 223 </ListItem>
 224 </VarListEntry>
 225 <VarListEntry>
 226 <Term>DtEDITOR_ALIGN_CENTER</Term>
 227 <ListItem>
 228 <Para>Centers each line of text between the left and right margins.
 229 </Para>
 230 </ListItem>
 231 </VarListEntry>
 232 <VarListEntry>
 233 <Term>DtEDITOR_ALIGN_JUSTIFY</Term>
 234 <ListItem>
 235 <Para>Aligns the text flush with both the left and right margins.
 236 </Para>
 237 </ListItem>
 238 </VarListEntry>
 239 <VarListEntry>
 240 <Term>DtEDITOR_ALIGN_LEFT</Term>
 241 <ListItem>
 242 <Para>Aligns the text flush with the left margin.
 243 </Para>
 244 </ListItem>
 245 </VarListEntry>
 246 <VarListEntry>
 247 <Term>DtEDITOR_ALIGN_RIGHT</Term>
 248 <ListItem>
 249 <Para>Aligns the text flush with the right margin.
 250 </Para>
 251 </ListItem>
 252 </VarListEntry>
 253 </VariableList>
 254 <Para>The
 255 header defines the following constant for use with the
 256 &cdeman.DtEditorGoToLine; function:
 257 </Para>
 258 <VariableList>
 259 <VarListEntry>
 260 <Term>DtEDITOR_LAST_LINE</Term>
 261 <ListItem>
 262 <Para>Moves the cursor to the beginning of the last line in the widget.
 263 </Para>
 264 </ListItem>
 265 </VarListEntry>
 266 </VariableList>
 267 <Para>The
 268 header defines the following
 269 <StructName Role="typedef">DtEditorErrorCode</StructName> constants:
 270 </Para>
 271 <VariableList>
 272 <VarListEntry>
 273 <Term>DtEDITOR_NO_ERRORS</Term>
 274 <ListItem>
 275 <Para>The function completed its task without errors.
 276 <![ %CDE.C.CDE; [</Para>
 277 </ListItem>
 278 </VarListEntry>
 279 <VarListEntry>
 280 <Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
 281 <ListItem>
 282 <Para>Not enough system memory is available to complete the task.
 283 ]]></Para>
 284 </ListItem>
 285 </VarListEntry>
 286 <VarListEntry>
 287 <Term>DtEDITOR_INVALID_TYPE</Term>
 288 <ListItem>
 289 <Para>The specified type is not a recognized
 290 <StructName Role="typedef">DtEditorDataFormat</StructName> when setting or retrieving contents or the specified
 291 Alignment type is not recognized when formatting text.
 292 </Para>
 293 </ListItem>
 294 </VarListEntry>
 295 <VarListEntry>
 296 <Term>DtEDITOR_INVALID_RANGE</Term>
 297 <ListItem>
 298 <Para>The starting character position in a text replacement is greater than
 299 the ending character position or the specified Amount To Format
 300 when formatting text is not recognized.
 301 </Para>
 302 </ListItem>
 303 </VarListEntry>
 304 <VarListEntry>
 305 <Term>DtEDITOR_NULL_ITEM</Term>
 306 <ListItem>
 307 <Para>The data buffer is
 308 <SystemItem Class="Constant">NULL</SystemItem> when passing data in a buffer.
 309 </Para>
 310 </ListItem>
 311 </VarListEntry>
 312 <VarListEntry>
 313 <Term>DtEDITOR_ILLEGAL_SIZE</Term>
 314 <ListItem>
 315 <Para>The specified size of a data buffer is negative when passing data in a
 316 buffer, or the left and right margin values are illegal when formatting text.
 317 <![ %CDE.C.CDE; [</Para>
 318 </ListItem>
 319 </VarListEntry>
 320 <VarListEntry>
 321 <Term>DtEDITOR_SPELL_FILTER_FAILED</Term>
 322 <ListItem>
 323 <Para>The
 324 <Function>DtEditor</Function> function cannot successfully execute the filter specified by the
 325 <SystemItem Class="Resource">DtNspellFilter</SystemItem> resource.
 326 </Para>
 327 </ListItem>
 328 </VarListEntry>
 329 <VarListEntry>
 330 <Term>DtEDITOR_NO_TMP_FILE</Term>
 331 <ListItem>
 332 <Para>The
 333 <Function>DtEditor</Function> function cannot create a temporary file in the directory returned by
 334 <Function>tmpnam</Function>3S. ]]></Para>
 335 </ListItem>
 336 </VarListEntry>
 337 <VarListEntry>
 338 <Term>DtEDITOR_INVALID_FILENAME</Term>
 339 <ListItem>
 340 <Para>No file was specified.
 341 </Para>
 342 </ListItem>
 343 </VarListEntry>
 344 <VarListEntry>
 345 <Term>DtEDITOR_NONEXISTENT_FILE</Term>
 346 <ListItem>
 347 <Para>The file specified for reading does not exist.
 348 </Para>
 349 </ListItem>
 350 </VarListEntry>
 351 <VarListEntry>
 352 <Term>DtEDITOR_UNREADABLE_FILE</Term>
 353 <ListItem>
 354 <Para>The file specified is unreadable for an unspecified reason.
 355 </Para>
 356 </ListItem>
 357 </VarListEntry>
 358 <VarListEntry>
 359 <Term>DtEDITOR_READ_ONLY_FILE</Term>
 360 <ListItem>
 361 <Para>The file is read only.
 362 <![ %CDE.C.CDE; [</Para>
 363 </ListItem>
 364 </VarListEntry>
 365 <VarListEntry>
 366 <Term>DtEDITOR_NULLS_REMOVED</Term>
 367 <ListItem>
 368 <Para>The file contained embedded
 369 <SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
 370 ]]></Para>
 371 </ListItem>
 372 </VarListEntry>
 373 <VarListEntry>
 374 <Term>DtEDITOR_NO_FILE_ACCESS</Term>
 375 <ListItem>
 376 <Para>The file cannot be accessed.
 377 </Para>
 378 </ListItem>
 379 </VarListEntry>
 380 <VarListEntry>
 381 <Term>DtEDITOR_DIRECTORY</Term>
 382 <ListItem>
 383 <Para>The file specified is a directory.
 384 </Para>
 385 </ListItem>
 386 </VarListEntry>
 387 <VarListEntry>
 388 <Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
 389 <ListItem>
 390 <Para>The file specified is a character-special device.
 391 </Para>
 392 </ListItem>
 393 </VarListEntry>
 394 <VarListEntry>
 395 <Term>DtEDITOR_BLOCK_MODE_FILE</Term>
 396 <ListItem>
 397 <Para>The file specified is a block-mode device.
 398 </Para>
 399 </ListItem>
 400 </VarListEntry>
 401 <VarListEntry>
 402 <Term>DtEDITOR_UNWRITABLE_FILE</Term>
 403 <ListItem>
 404 <Para>The application does not have write permission for the file or directory.
 405 </Para>
 406 </ListItem>
 407 </VarListEntry>
 408 <VarListEntry>
 409 <Term>DtEDITOR_WRITABLE_FILE</Term>
 410 <ListItem>
 411 <Para>The specified file exists and the
 412 <Emphasis>overwriteIfExists</Emphasis> flag is set to
 413 False.
 414 </Para>
 415 </ListItem>
 416 </VarListEntry>
 417 <VarListEntry>
 418 <Term>DtEDITOR_SAVE_FAILED</Term>
 419 <ListItem>
 420 <Para>The contents of the widget could not be saved for an unspecified reason.
 421 </Para>
 422 </ListItem>
 423 </VarListEntry>
 424 </VariableList>
 425 <Para>The
 426 header defines the following
 427 enumeration values as reasons for the
 428 <SystemItem Class="Resource">DtNtextSelectCallback</SystemItem>:</Para>
 429 <VariableList>
 430 <VarListEntry>
 431 <Term>DtEDITOR_TEXT_SELECT</Term>
 432 <ListItem>
 433 <Para>Some text has been selected within the edit window (that is, the selection
 434 has become non-
 435 <SystemItem Class="Constant">NULL</SystemItem>).</Para>
 436 </ListItem>
 437 </VarListEntry>
 438 <VarListEntry>
 439 <Term>DtEDITOR_TEXT_DESELECT</Term>
 440 <ListItem>
 441 <Para>No text is selected within the edit window (that is, the selection
 442 has become
 443 <SystemItem Class="Constant">NULL</SystemItem>).</Para>
 444 </ListItem>
 445 </VarListEntry>
 446 </VariableList>
 447 <Para>The
 448 header defines the following constants as reasons for the
 449 <SystemItem Class="Resource">XmNhelpCallback</SystemItem>:</Para>
 450 <VariableList>
 451 <VarListEntry>
 452 <Term>DtEDITOR_HELP_EDIT_WINDOW</Term>
 453 <ListItem>
 454 <Para>The help request originated in the edit window.
 455 <![ %CDE.C.CDE; [</Para>
 456 </ListItem>
 457 </VarListEntry>
 458 <VarListEntry>
 459 <Term>DtEDITOR_HELP_STATUS_LINE</Term>
 460 <ListItem>
 461 <Para>The help request originated in the status line.
 462 </Para>
 463 </ListItem>
 464 </VarListEntry>
 465 <VarListEntry>
 466 <Term>DtEDITOR_HELP_STATUS_CURRENT_LINE</Term>
 467 <ListItem>
 468 <Para>The help request originated from the Current Line Number
 469 display in the status line.
 470 </Para>
 471 </ListItem>
 472 </VarListEntry>
 473 <VarListEntry>
 474 <Term>DtEDITOR_HELP_STATUS_TOTAL_LINES</Term>
 475 <ListItem>
 476 <Para>The help request originated from the Total Lines display in
 477 the status line.
 478 </Para>
 479 </ListItem>
 480 </VarListEntry>
 481 <VarListEntry>
 482 <Term>DtEDITOR_HELP_STATUS_MESSAGE</Term>
 483 <ListItem>
 484 <Para>The help request originated from the Message field in the
 485 status line.
 486 </Para>
 487 </ListItem>
 488 </VarListEntry>
 489 <VarListEntry>
 490 <Term>DtEDITOR_HELP_STATUS_OVERSTRIKE</Term>
 491 <ListItem>
 492 <Para>The help request originated from the Overstrike indicator
 493 in the status line.
 494 ]]></Para>
 495 </ListItem>
 496 </VarListEntry>
 497 <VarListEntry>
 498 <Term>DtEDITOR_HELP_FORMAT_DIALOG</Term>
 499 <ListItem>
 500 <Para>The help request originated from the Help button in the
 501 Format Settings dialog.
 502 </Para>
 503 </ListItem>
 504 </VarListEntry>
 505 <VarListEntry>
 506 <Term>DtEDITOR_HELP_FORMAT_LEFT_MARGIN</Term>
 507 <ListItem>
 508 <Para>The help request originated from the Left Margin field in
 509 the Format Settings dialog.
 510 </Para>
 511 </ListItem>
 512 </VarListEntry>
 513 <VarListEntry>
 514 <Term>DtEDITOR_HELP_FORMAT_RIGHT_MARGIN</Term>
 515 <ListItem>
 516 <Para>The help request originated from the Right Margin Field in
 517 the Format Settings dialog.
 518 </Para>
 519 </ListItem>
 520 </VarListEntry>
 521 <VarListEntry>
 522 <Term>DtEDITOR_HELP_FORMAT_ALIGNMENT</Term>
 523 <ListItem>
 524 <Para>The help request originated from the Alignment buttons in the Format Settings
 525 dialog.
 526 </Para>
 527 </ListItem>
 528 </VarListEntry>
 529 <VarListEntry>
 530 <Term>DtEDITOR_HELP_CHANGE_DIALOG</Term>
 531 <ListItem>
 532 <Para>The help request originated from the Help button in the Find/Change dialog.
 533 </Para>
 534 </ListItem>
 535 </VarListEntry>
 536 <VarListEntry>
 537 <Term>DtEDITOR_HELP_CHANGE_FIND</Term>
 538 <ListItem>
 539 <Para>The help request originated from the Find field in the Find/Change dialog.
 540 </Para>
 541 </ListItem>
 542 </VarListEntry>
 543 <VarListEntry>
 544 <Term>DtEDITOR_HELP_CHANGE_CHANGE</Term>
 545 <ListItem>
 546 <Para>The help request originated from the Change To field in the Find/Change dialog.
 547 <![ %CDE.C.CDE; [</Para>
 548 </ListItem>
 549 </VarListEntry>
 550 <VarListEntry>
 551 <Term>DtEDITOR_HELP_SPELL_DIALOG</Term>
 552 <ListItem>
 553 <Para>The help request originated from the Help button in the Spell dialog.
 554 </Para>
 555 </ListItem>
 556 </VarListEntry>
 557 <VarListEntry>
 558 <Term>DtEDITOR_HELP_SPELL_MISSPELLED_WORDS</Term>
 559 <ListItem>
 560 <Para>The help request originated from the list of misspelled words in the Spell dialog.
 561 </Para>
 562 </ListItem>
 563 </VarListEntry>
 564 <VarListEntry>
 565 <Term>DtEDITOR_HELP_SPELL_CHANGE</Term>
 566 <ListItem>
 567 <Para>The help request originated from the Change To field in the Spell dialog.
 568 ]]></Para>
 569 </ListItem>
 570 </VarListEntry>
 571 </VariableList>
 572 <Para>The
 573 header defines the following as functions:
 574 </Para>
 575 <Synopsis>Widget DtCreateEditor(Widget <Symbol Role="Variable">parent</Symbol>,
 576         char *<Symbol Role="Variable">name</Symbol>,
 577         ArgList <Symbol Role="Variable">arglist</Symbol>,
 578         Cardinal <Symbol Role="Variable">argcount</Symbol>);
 579 </Synopsis>
 580 <Synopsis>DtEditorErrorCode DtEditorAppend(Widget <Symbol Role="Variable">widget</Symbol>,
 581         DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
 582 </Synopsis>
 583 <Synopsis>DtEditorErrorCode DtEditorAppendFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
 584         char *<Emphasis>fileName</Emphasis>);
 585 </Synopsis>
 586 <Synopsis>Boolean DtEditorChange(Widget <Symbol Role="Variable">widget</Symbol>,
 587         DtEditorChangeValues *<Emphasis>findChangeStrings</Emphasis>,
 588         unsigned int <Emphasis>instanceToChange</Emphasis>);
 589 </Synopsis>
 590 <Synopsis>Boolean DtEditorCheckForUnsavedChanges(Widget <Symbol Role="Variable">widget</Symbol>);
 591 </Synopsis>
 592 <Synopsis>Boolean DtEditorClearSelection(Widget <Symbol Role="Variable">widget</Symbol>);
 593 </Synopsis>
 594 <Synopsis>Boolean DtEditorCopyToClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
 595 </Synopsis>
 596 <Synopsis>Boolean DtEditorCutToClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
 597 </Synopsis>
 598 <Synopsis>Boolean DtEditorDeleteSelection(Widget <Symbol Role="Variable">widget</Symbol>);
 599 </Synopsis>
 600 <Synopsis>Boolean DtEditorDeselect(Widget <Symbol Role="Variable">widget</Symbol>);
 601 </Synopsis>
 602 <![ %CDE.C.CDE; [
 603 <Synopsis>void DtEditorDisableRedisplay(Widget <Symbol Role="Variable">widget</Symbol>);
 604 </Synopsis>
 605 <Synopsis>void DtEditorEnableRedisplay(Widget <Symbol Role="Variable">widget</Symbol>);
 606 </Synopsis>
 607 ]]>
 608 <Synopsis>Boolean DtEditorFind(Widget <Symbol Role="Variable">widget</Symbol>,
 609         char * <Emphasis>find</Emphasis>);
 610 </Synopsis>
 611 <Synopsis>DtEditorErrorCode DtEditorFormat(Widget <Symbol Role="Variable">widget</Symbol>,
 612         DtEditorFormatSettings *<Emphasis>formatSettings</Emphasis>,
 613         unsigned int <Emphasis>amountToFormat</Emphasis>);
 614 </Synopsis>
 615 <Synopsis>DtEditorErrorCode DtEditorGetContents(Widget <Symbol Role="Variable">widget</Symbol>,
 616         DtEditorContentRec *<Symbol Role="Variable">data</Symbol>,
 617         Boolean <Emphasis>hardCarriageReturns</Emphasis>,
 618         Boolean <Emphasis>markContentsAsSaved</Emphasis>);
 619 </Synopsis>
 620 <Synopsis>XmTextPosition DtEditorGetInsertionPosition(Widget <Symbol Role="Variable">widget</Symbol>);
 621 </Synopsis>
 622 <Synopsis>XmTextPosition DtEditorGetLastPosition(Widget <Symbol Role="Variable">widget</Symbol>);
 623 </Synopsis>
 624 <Para><![ %CDE.C.CDE; [</Para>
 625 <Synopsis>Widget DtEditorGetMessageTextFieldID(Widget <Symbol Role="Variable">widget</Symbol>);
 626 </Synopsis>
 627 <Para>]]></Para>
 628 <Synopsis>void DtEditorGetSizeHints(Widget <Symbol Role="Variable">widget</Symbol>,
 629         XSizeHints *<Emphasis>pHints</Emphasis>);
 630 </Synopsis>
 631 <Synopsis>void DtEditorGoToLine(Widget <Symbol Role="Variable">widget</Symbol>,
 632         int <Emphasis>lineNumber</Emphasis>);
 633 </Synopsis>
 634 <Synopsis>DtEditorErrorCode DtEditorInsert(Widget <Symbol Role="Variable">widget</Symbol>,
 635         DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
 636 </Synopsis>
 637 <Synopsis>DtEditorErrorCode DtEditorInsertFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
 638         char *<Emphasis>fileName</Emphasis>);
 639 </Synopsis>
 640 <Synopsis>void DtEditorInvokeFindChangeDialog(Widget <Symbol Role="Variable">widget</Symbol>);
 641 </Synopsis>
 642 <Synopsis>void DtEditorInvokeFormatDialog(Widget <Symbol Role="Variable">widget</Symbol>);
 643 </Synopsis>
 644 <Para><![ %CDE.C.CDE; [</Para>
 645 <Synopsis>DtEditorErrorCode DtEditorInvokeSpellDialog(Widget <Symbol Role="Variable">widget</Symbol>);
 646 </Synopsis>
 647 <Para>]]></Para>
 648 <Synopsis>Boolean DtEditorPasteFromClipboard(Widget <Symbol Role="Variable">widget</Symbol>);
 649 </Synopsis>
 650 <Synopsis>DtEditorErrorCode DtEditorReplace(Widget <Symbol Role="Variable">widget</Symbol>,
 651         XmTextPosition <Symbol Role="Variable">startPos</Symbol>,
 652         XmTextPosition <Symbol Role="Variable">endPos</Symbol>,
 653         DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
 654 </Synopsis>
 655 <Synopsis>DtEditorErrorCode DtEditorReplaceFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
 656         XmTextPosition <Symbol Role="Variable">startPos</Symbol>,
 657         XmTextPosition <Symbol Role="Variable">endPos</Symbol>,
 658         char *<Emphasis>fileName</Emphasis>);
 659 </Synopsis>
 660 <Para><![ %CDE.C.CDE; [</Para>
 661 <Synopsis>void DtEditorReset(Widget <Symbol Role="Variable">widget</Symbol>);
 662 </Synopsis>
 663 <Para>]]></Para>
 664 <Synopsis>DtEditorErrorCode DtEditorSaveContentsToFile(Widget <Symbol Role="Variable">widget</Symbol>,
 665         char *<Emphasis>fileName</Emphasis>,
 666         Boolean <Emphasis>overwriteIfExists</Emphasis>,
 667         Boolean <Emphasis>hardCarriageReturns</Emphasis>,
 668         Boolean <Emphasis>markContentsAsSaved</Emphasis>);
 669 </Synopsis>
 670 <Synopsis>Boolean DtEditorSelectAll(Widget <Symbol Role="Variable">widget</Symbol>);
 671 </Synopsis>
 672 <Synopsis>DtEditorErrorCode DtEditorSetContents(Widget <Symbol Role="Variable">widget</Symbol>,
 673         DtEditorContentRec *<Symbol Role="Variable">data</Symbol>);
 674 </Synopsis>
 675 <Synopsis>DtEditorErrorCode DtEditorSetContentsFromFile(Widget <Symbol Role="Variable">widget</Symbol>,
 676         char *<Emphasis>fileName</Emphasis>);
 677 </Synopsis>
 678 <Synopsis>void DtEditorSetInsertionPosition(Widget <Symbol Role="Variable">widget</Symbol>,
 679                 XmTextPosition <Symbol Role="Variable">position</Symbol>);
 680 </Synopsis>
 681 <Synopsis>void DtEditorTraverseToEditor(Widget <Symbol Role="Variable">widget</Symbol>);
 682 </Synopsis>
 683 <Synopsis>Boolean DtEditorUndoEdit(Widget <Symbol Role="Variable">widget</Symbol>);
 684 </Synopsis>
 685 </RefSect1>
 686 <![ %CDE.C.CDE; [
 687 <RefSect1>
 688 <Title>SEE ALSO</Title>
 689 <Para>&cdeman.DtCreateEditor;, &cdeman.DtEditor;,
 690 &cdeman.DtEditorAppend;,
 691 &cdeman.DtEditorAppendFromFile;,
 692 &cdeman.DtEditorChange;,
 693 &cdeman.DtEditorCheckForUnsavedChanges;,
 694 &cdeman.DtEditorClearSelection;,
 695 &cdeman.DtEditorCopyToClipboard;,
 696 &cdeman.DtEditorCutToClipboard;,
 697 &cdeman.DtEditorDeleteSelection;,
 698 &cdeman.DtEditorDeselect;, &cdeman.DtEditorFind;,
 699 &cdeman.DtEditorFormat;,
 700 &cdeman.DtEditorGetContents;,
 701 &cdeman.DtEditorGetInsertionPosition;,
 702 &cdeman.DtEditorGetLastPosition;,
 703 &cdeman.DtEditorGetMessageTextFieldID;,
 704 &cdeman.DtEditorGetSizeHints;,
 705 &cdeman.DtEditorGoToLine;, &cdeman.DtEditorInsert;,
 706 &cdeman.DtEditorInsertFromFile;,
 707 &cdeman.DtEditorInvokeFindChangeDialog;,
 708 &cdeman.DtEditorInvokeFormatDialog;,
 709 &cdeman.DtEditorInvokeSpellDialog;,
 710 &cdeman.DtEditorPasteFromClipboard;,
 711 &cdeman.DtEditorReplace;,
 712 &cdeman.DtEditorReplaceFromFile;,
 713 &cdeman.DtEditorReset;,
 714 &cdeman.DtEditorSaveContentsToFile;,
 715 &cdeman.DtEditorSelectAll;,
 716 &cdeman.DtEditorSetContents;,
 717 &cdeman.DtEditorSetContentsFromFile;,
 718 &cdeman.DtEditorSetInsertionPosition;,
 719 &cdeman.DtEditorTraverseToEditor;,
 720 &cdeman.DtEditorUndoEdit;.</Para>
 721 </RefSect1>
 722 ]]>
 723 </RefEntry>
 724 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->