85 lines
3.4 KiB
Plaintext
85 lines
3.4 KiB
Plaintext
<!-- $XConsortium: EdGoToLi.sgm /main/5 1996/08/30 13:00:10 rws $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
|
|
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN29.rsml.1">]]>
|
|
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN29.rsml.1">]]>
|
|
<RefMeta>
|
|
<RefEntryTitle>DtEditorGoToLine</RefEntryTitle>
|
|
<ManVolNum>library call</ManVolNum>
|
|
</RefMeta>
|
|
<RefNameDiv>
|
|
<RefName><Function>DtEditorGoToLine</Function></RefName>
|
|
<RefPurpose>move the insert cursor for a DtEditor widget to a specified line
|
|
</RefPurpose>
|
|
</RefNameDiv>
|
|
<!-- CDE Common Source Format, Version 1.0.0-->
|
|
<!-- *************************************************************************-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
|
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
|
<!-- ***********************************************************************-->
|
|
<RefSynopsisDiv>
|
|
<FuncSynopsis Remap="ANSI">
|
|
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
|
</FuncSynopsisInfo>
|
|
<FuncDef>void <Function>DtEditorGoToLine</Function></FuncDef>
|
|
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
|
<ParamDef>int <Parameter>lineNumber</Parameter></ParamDef>
|
|
</FuncSynopsis>
|
|
</RefSynopsisDiv>
|
|
<RefSect1>
|
|
<Title>DESCRIPTION</Title>
|
|
<Para>The
|
|
<Function>DtEditorGoToLine</Function> function moves the insert cursor for the DtEditor widget to the beginning of the
|
|
line specified by the
|
|
<Emphasis>lineNumber</Emphasis> argument.
|
|
The cursor can be moved to the last
|
|
line by specifying
|
|
<SystemItem Class="Constant">DtEDITOR_LAST_LINE</SystemItem> as the line number.
|
|
If the line is not currently on-screen, the contents for the DtEditor widget
|
|
are scrolled to display the new insertion position.
|
|
</Para>
|
|
<Para>The
|
|
<Emphasis>lineNumber</Emphasis> argument is the number of the line in the file,
|
|
counting from 1.
|
|
If the
|
|
<Emphasis>lineNumber</Emphasis> argument is less than 1, the insert cursor is placed
|
|
at the beginning of the first line.
|
|
If the argument is greater than the total
|
|
number of lines, the cursor is placed at the last line of text.
|
|
</Para>
|
|
<Para>The insert cursor can be moved to a specific character position with
|
|
&cdeman.DtEditorSetInsertionPosition;. The
|
|
<SystemItem Class="Resource">DtNtopCharacter</SystemItem> resource can be used to control which line is displayed at the top of the
|
|
DtEditor widget.
|
|
</Para>
|
|
<Para>The
|
|
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
|
</Para>
|
|
<Para>The
|
|
<Emphasis>lineNumber</Emphasis> argument specifies the line number within the DtEditor widget.
|
|
<![ %CDE.C.CDE; [</Para>
|
|
<Para>For a complete definition of the DtEditor widget
|
|
and its associated resources, see
|
|
&cdeman.DtEditor;. ]]></Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>RETURN VALUE</Title>
|
|
<Para>The
|
|
<Function>DtEditorGoToLine</Function> function returns no value.
|
|
</Para>
|
|
</RefSect1>
|
|
<RefSect1>
|
|
<Title>SEE ALSO</Title>
|
|
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorSetInsertionPosition;.</Para>
|
|
</RefSect1>
|
|
</RefEntry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|