Class PvxPreferences

This object is used to create a standard interface for accessing preferences of an event so that all logic associated with the processing that occurs during the event can access this data. A reference to this object is part of the state information for each event.

Build Information

Author Fred McGuirk
Date Dec 27, 2006
Outputfile PvxPreferences.pvc
Forcelinenumbers false

Constructor

Load the current values for all preferences into this class object.

Properties

No Properties

Methods

FUNCTION addPreference(eclipseData)

Add a preference


ParameterDescription
eclipseData A reference to [ProvideX Class:pvx_data]
FUNCTION containsPreference(prefKey$)

Returns true (1) if there is a preference with the name specified.

ParameterDescription
prefKey$ The name of the preference to be found.
FUNCTION deletePreference(prefKey$)

Delete a preference with the name specified, if it exists

FUNCTION getBooleanPreference(thisName$)

Return a value (0=False, 1=True) for the boolean preference with the name specified

FUNCTION getPreference(prefKey$)

Return a reference to [ProvideX Class:pvx_data] for the preference with the name specified

FUNCTION getStringPreference$(thisName$)

Return the value of the string preference with the name specified

FUNCTION load_Preferences()

Load the preferences from [Java Class:preferences.PreferenceManager]

FUNCTION preferenceIterator()

Initialize an iterator for the preferences [ProvideX Library Class:*obj/group] object


The preferences are access using the following constants:

ValueDescription
_pvxConstants'_iEclipseBuilderSocket$ TCP/IP socket to be used for commuication with the plug-in
_pvxConstants'_iBuildCheckStructure$ BUILD: Enable check of program structure during build process
_pvxConstants'_iBuildProgress$ BUILD: Enable build progress bar to show per centage of woek completed
_pvxConstants'_iDisableCstyleComments$ BUILD: Disable C-Style block comments
_pvxConstants'_iOutlineExcludeVars$ BUILD: Include variables in the outline view for programs
_pvxConstants'_iBuildMaintainCase$ BUILD: Allow mixed case for variables and line labels
_pvxConstants'_ibDOAUTOFORMAT$ BUILD: Automatically reformat during SAVE
_pvxConstants'_iShowSizeWarning$ BUILD: Show 64K program size warning
_pvxConstants'_iStripSourceExtension$ BUILD: Strip the default source file extension from output file name
_pvxConstants'_iDefaultTokenPgmExt$ BUILD: Default extension to be appended to output file name if there is no extension
_pvxConstants'_ibUseStartUp$ BUILD: Use a program to initialize build environment
_pvxConstants'_LineNumberInc$ BUILD: Type of auto-increment when assigning line numbers
_pvxConstants'_ibAltStartUp$ BUILD: Full path of program used to initialize build environment
_pvxConstants'_ibBTI_Enable$ BUILD: Enable Load/Save to "project.BuildTagInfo.pvk" control file
_pvxConstants'_ibMasBuildOne$ BUILD: Enable MAS 'project.BuildOne.pvx' during build
_pvxConstants'_ibDebug$ LOG: Enable event logging
_pvxConstants'_ibDebugProcessMessages$ LOG: Show process debug status messages
_pvxConstants'_ibDebugLog$ LOG: Log file for event information
_pvxConstants'_ibDebugSize$ LOG: Maximum number of events in the event window; oldest will be deleted.
_pvxConstants'_iShowEventParm$ LOG: Show event parameters (none, list, values)
_pvxConstants'_iSuppressDataPassword$ IMPORT: Suppress request for passwords on protected data files
_pvxConstants'Import_Formatlist$ IMPORT: Format source code during import
_pvxConstants'Import_Lowercase_Dir$ IMPORT: All directives converted to lowercase
_pvxConstants'Import_Lowercase_Vars$ IMPORT: All variables converted to lowercase
_pvxConstants'Import_Strip_Line_Label_Prefix$ IMPORT: Prefix to be placed at begining of line labels when stripping line numbers
_pvxConstants'Import_Strip_Line_no$ IMPORT: Strip line numbers
_pvxConstants'Import_Strip_Line_Use_Orig_no$ IMPORT: Use orginal line number (instead of a counter) in the auto-generated labels
_pvxConstants'Import_SuppressLet$ IMPORT: Suppress the LET directive
_pvxConstants'Import_SrcFile_Extension$ IMPORT: File extension to be added to files
_pvxConstants'_iAddSourceExtension$ IMPORT: Always add source file extension
_pvxConstants'_extObserverEnable$ OBSERVERS: Enable external observers
_pvxConstants'_extObserverUserDir$ OBSERVERS: Directory for user-defined observers
_pvxConstants'_KeywordConversion$ EDIT-OPTIONS: Keyword conversion rule
_pvxConstants'_KC_ConvertLabels$ EDIT-OPTIONS: Convert Line Labels during Keyword conversion process
_pvxConstants'_NOMADS_Default_Suffix NOMADS: Default library suffix
_pvxConstants'_NOMADS_Panel_Suppress_VAL NOMADS: Suppress '.VAL' for variable values
_pvxConstants'_NOMADS_Panel_Column NOMADS: Default column for new panel
_pvxConstants'_NOMADS_Panel_Line NOMADS: Default line for new panel
_pvxConstants'_NOMADS_Panel_Width NOMADS: Default width of new panel
_pvxConstants'_NOMADS_Panel_Height NOMADS: Default height of new panel
_pvxConstants'_NOMADS_Panel_GUI_Style NOMADS: Default GUI style
_pvxConstants'_NOMADS_Panel_Grid_Def NOMADS: Default Grid definition
@calue _pvxConstants'_NOMADS_ExtImageDir$ NOMADS: External Image folder