Vr Mapping

ON-LINE REFERENCE DOCUMENTATION

CARDINAL SYSTEMS, LLC

www.cardinalsystems.net

Menu Keys Class Reference (PyVrMenuKeys)

Python VrMenuKeys Class More...

Description

This clas displays a standard menu keys dialog. The dialog can be customized and a callback function can be used to respond to the user pressing buttons on the menu keys dialog. This class can be used along with the PyVrApp class to create full event-driven applications in VrOne.

 

Member Function Documentation
 

PyVrMenuKeys (Title, NumLines)

 

Class constructor.

Title

Title string.

NumLines

Number of  lines in information area (above buttons).

 
SetTitle (Title)

Sets title of dialog box.

Title

Title string.

SetMkLabel (KeyNum, Label)

Sets a label on a single menu key button.

KeyNum

Button number to label (1-12).

Label

Label string.

EnableMkLabel (KeyNum)

Enables a single menu key button.

KeyNum

Button number (1-12).

DisableMkLabel (KeyNum)

Disables a single menu key button.

KeyNum

Button number (1-12).

SetMkLabels (Title, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9, Key10, Key0, Key11)

Sets all menu key button labels.

Title

Set dialog title.

Key1

Label for key 1.

Key2

Label for key 2.

Key3

Label for key 3.

Key4

Label for key 4.

Key5

Label for key 5.

Key6

Label for key 6.

Key7

Label for key 7.

Key8

Label for key 8.

Key9

Label for key 9.

Key10

Label for key 10.

Key0

Label for key 11.

Key11

Label for key 12.

PushMk ()

Saves menu key labels onto a stack. May be called multiple times. Use PopMk to restore menu keys that have been stored using PushMk.

PopMk ()

Restores last menu keys labels that were stored using PushMk.

SetIaLabel1 (LineNum, Label)

Sets a single line label at top of Menu Keys dialog.

LineNum

Line number of label.

Label

Label string

SetIaLabel2 (LineNum, Keyword, Arg)

Sets a single line label at top of Menu Keys dialog in a keyword-argument format using a short argument.

LineNum

Line number of label.

Keyword

Keyword string.

Arg

Argument value.

SetIaLabel3 (LineNum, Keyword, Arg)

Sets a single line label at the top of Menu Keys dialog in a keyword-argument format using an int argument.

LineNum

Line number of label.

Keyword

Keyword string.

Arg

Argument value.

SetIaLabel4 (LineNum, Keyword, Arg, DecAccur)

LineNum

Line number of label.

Keyword

Keyword string.

Arg

Argument value.

DecAccur

Decimal accuracy of Arg

SetIaLabel5 (LineNum, Keyword, Arg)

LineNum

Line number of label.

Keyword

Keyword string.

Arg

Argument string.

SetIaLabel6 (LineNum, Keyword, Index, Lab0,...)

Sets a line of text in the Information Area using and index and a list of possible strings for that index.

LineNum

Information Area line number. (0 - NumLabels-1).

Keyword

Keyword (i.e LAYMOD).

Index

Index to list of strings.

Lab0,...

Possible string items for Index.

ClearIa ()

Clears information area labels.

Hide ()

Hides menu keys dialog.

Show ()

Shows menu keys dialog.

Raise ()

Raises menu keys dialog to the top of other dialogs.

ShowLine (Line)

Shows information about a VrLine in the information area.

Line

VrLine object.

ShowCount (Line)

Shows point count information for one VrLine in the information area.

Line

VrLine object.

ShowPntNum (PntNum, Line, PntCnt)

Shows point number and point count information for one VrLine in the information area.

PntNum

Current point number.

Line

VrLine object.

PntCnt

Total point count.

ShowPntFlags (PntNum, Line)

Shows point flags information for one VrLine in the information area.

PntNum

Current point number.

Line

VrLine object.

ShowSym (Sym)

Shows information about a VrSymbol in the information area.

Sym

VrSym object.

ShowText (Text)

Shows information about a VrText in the information area.

Text

VrText object.

ShowTextJust (Text)

Shosw justification information about a VrText in the information area.

Text

VrText object.

ShowWs (Ws)

Shows workspace number in the information area.

Ws

Workspace number

ShowEntNum (EntNum, EntType)

Shows entity number the information area.

EntNum

Entity number.

EntType

Entity type.

1= Line.

2= Splined line .

3= Symbol

4=Text (optional).

SetKeyCB (Function)

Sets Python callback function to be called when a menu key is pressed.

Function

Python function to handle menu key events. This function must be created in the Python script. The function should have the following format: 'def MyAppKeyCB (key):'