summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p314
blob: 2d6d741ce56d9b1f88bde1ada373e57a0087c3a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.\"##
.\" $XConsortium: p314,v 5.2 94/04/17 20:58:05 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "SET EDIT MODE" 3P "29 February 1991"
.SH NAME
SET EDIT MODE \- set the edit mode controlling how new structure elements are added to the open structure
.IX "Editing" "SET EDIT MODE"
.IX "Replace Mode" "SET EDIT MODE"
.IX "Insert Mode" "SET EDIT MODE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pset_edit_mode ( mode )
Pedit_mode	mode;	\fIedit mode\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
The \s-2SET EDIT MODE\s+2 subroutine sets the edit mode controlling how \s-2PHIGS\s+2 subroutines that create new structure elements will add the new element to the open structure.
The mode may be Insert or Replace.
.LP
Insert is the default.
.SS C Input Parameter
.IP \fImode\fP
An enumerated variable specifying the edit mode to be used to add new elements to the open structure.
Valid values (defined in phigs.h) are:
.sp
.ta .3i
.nf
	PEDIT_INSERT
	PEDIT_REPLACE
.fi
.SS Execution
The \s-2SET EDIT MODE\s+2 subroutine sets the edit mode in the 
traversal state list to Insert or Replace. The value in this entry 
controls how \s-2PHIGS\s+2 subroutines that create new structure elements 
add the new element to the currently open structure.
.LP
While the edit mode is Insert, new structure elements are inserted into the open structure after the element pointed to by the current element pointer.
.LP
While the edit mode is Replace, new structure elements replace the element in the open structure pointed to by the current element pointer.
.SH ERRORS
.IP 002
Ignoring function, function requires state (PHOP, *, *, *)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE EDIT MODE (3P)"
.SM "DELETE ELEMENT (3P)"
.fi