protocollum class

(top level)

create	key gate event args	Create a gui::Seg_ object and display a view of it on the current canvas (procedure)
destroy		Delete a gui::Seg_ object and undisplay any views
move	mode args	Move a view of the Segment object around on a drawing canvas
optget	option	Optain a value for the specified graphical option
optmod	args	Set a value for a graphical option, or obtain option list(s), do arch checks, history, update
update	args	Bring the current view of the object up-to-date with the architecture state

(low level)

activate	sbtag	(not used, but required for Selectboxe objects)
addSelectBoxes		Show selection boxes on the current view of the object
buildTree	top	Build the architectural state and graphical defaults of the object into a DOM tree
buildTree_gui	top vw	Build the graphical values of the specified view into a DOM tree
constructor	gate event args
deactivate	args
delete	args	Destroy the object
deleteSelectBoxes		Undo the effects of 'addSelectBoxes'
deploy		A view of the object is displayed and sub-objects are also deployed
destructor
display	args	Display a graphical view of the object on the current canvas
getCanvas
getCommand	mode	Returns a string that can be used to re-create/display/copy the object as it exists now
getGraphicsId	piece
getOptions	args	Return information about the options for this object
getPcode
getProperties		(procedure)
getPropertyList
isEditable		(procedure)
isOkToDelete		Determine if it is ok to delete the object.
moveDist	orient xDist yDist
moveTo	orient x y
raise
recall		Any view is undisplayed and sub-objects are also recalled
resize	args
select
undisplay	{view {}}	Undisplay a view of the object
unselect

Public Method Details

activate
	One of the selectboxes on the Seg has been selected selected, and we will do Nothing!

addSelectBoxes
	Determine locations for selection boxes and then create the selectbox objects.

buildTree top

The architectural state and initial graphical state of the Seg object are grafted onto the DOM tree element indicated.

top
	a pointer to a tree element

buildTree_gui top view

The current graphical state of the specified view is grafted onto the DOM tree element indicated.

top
	a pointer to a tree element

view
	the View (Edit sheet) from which to obtain the view of the Seg object

constructor
	Use the itcl::class definition to create a Segment object.

create key gate event ?options?

A gui::Seg_ object is created with name <key>. The segment starts at the object <gate> and ends at object <event>. A view of the object is displayed on the current canvas.

Graphical options can be passed in which will be used as default values for all subsequent views of the object which are displayed on any canvas. (Any graphical options not specified will use the class values set up during program start up.)

The command is put onto the Hist/Undo stack.

key
	used to create a name for the object
	can be #auto, see documentation for itcl::class

gate
	must be a valid Gate object tag

event
	must be a valid Event object tag

?options?
	graphical options (see options )

deactivate

delete
	Destroy the object

deleteSelectBoxes
	Remove selectbox objects form the Segment.

deploy
	Show a view of the object on the current canvas

destroy
	After checking that architectural conditions are met, a gui::Seg_ is deleted and all views are undisplayed. The command is put onto the Hist/Undo stack.

destructor
	Undisplay all views of the object on any canvas and itcl::delete the object.

display
	Show the graphical items for this object on the current canvas.

getCanvas

getCommand
	A string is returned which contains the 'create' method and a list of options which will allow the object to be re-created as it currently exists.

getGraphicsId

getOptions
	see command explanation here
	see graphical options here

getPcode

getProperties

getPropertyList

isEditable

isOkToDelete

move

Move a Segment on a canvas. Only one end at a time can be moved. Same modes and usage as pe An additional argument -dir is explained below.

?optional args?
	arguments used depending on mode

-dir <dir>
	indicate which end of seg is to be moved, required for modes: to, start
	allowed:	gate, event

moveDist

moveTo

optget
	see command explanation here
	see graphical options here

optmod
	see command explanation here
	see graphical options here

raise

recall
	Any view of the object on the current canvas is undisplayed. The command is put onto the Hist/Undo stack.

resize

select

undisplay

Remove the graphical items from the canvas which comprise a "view" of the object.

view
	View tag which contains the object view to be undisplayed.
	if no View tag is given, try to remove a view of the object on the current canvas.

unselect

update ?options?

Bring the view of the Segment up-to-date with the Architecture. Architecture changes could have been made in other views that need to be reflected onto this view of the object.

?options?

choose pieces to be updated (default is all)

none
	(nothing right now)

Private Methods

_displayStub
_getOrigin	which
_initopts
_setLinewidth	lw

State

	Protection	Type
_lastX	private	variable
_lastY	private	variable
_lview	private	variable
_opt	private	variable
_opti	private	variable
_propertylist	private	common
_sb_event	private	variable
_sb_gate	private	variable
_sb_placed	private	variable
_startX	private	variable
_startY	private	variable
_tag	private	variable
_tag	private	variable
_temp	private	variable
EventTag	public	variable	Tag of Event object at other end of this Segment
GateTag	public	variable	Tag of Gate object at one end of this Segment
Type	public	variable	allowable types: in, out

Class - Seg_

Inheritance - ::gui::Seg_ ::mps::Seg_

Public Methods

(top level)

(low level)

Public Method Details

Private Methods

State