Overview

The objective here is three fold.

1. It provides a central area to refer to constants used throughout the Grail package.
2. Re-using the same constant tends to increase the speed of the python interpreter.
3. Will make internalization of the library easier in the future.

Consider this file as the Resource file for the entire MineSight® Grail library. It is recommended that you always attempt to preserve name space with this module. It helps to flag the fact that technically these values SHOULD be immutable. Re-setting a value in this module to another value will lead to unspecified results.

The recommend method for importing is,

from grail import const

or

import grail.const

Naming Convention

The constants in this file are named with the following format.

<prefix>CAPITAL_LETTERS

The prefix denotes the category for the constant, and the CAPITAL_LETTERS are used to try and mentally flag that the values should be immutable.

Constant Categories

The categories for this file are as follows,

color :

A color constant used for Tkinter. This is not an exhaustive listing, and is mainly only updated on a needed basis only.

str :

All strings that could be displayed to the user.

sig :

Signal names. Using the constant value increases portability of your code.

environ :

Environment variable names that the Grail Library would be interested.

reg :

Windows Registry locations that the Grail Library would be interested in using.

exc :

Error messages generated by exceptions.

Constants

FLOATING_POINT_TOLERANCE

MAX_FLOAT

colorBLACK

colorDISABLED_BACKGROUND

colorDISABLED_FOREGROUND

colorENABLED_BACKGROUND

colorENABLED_FOREGROUND

colorERROR_BACKGROUND

colorERROR_FOREGROUND

colorFORMAT_STRING

colorLIGHT_GREY

colorWHITE

colorWINDOW_GREY

environMEDEXE

environMETLIB

excPROGRAMMERS_ERROR

excRTVERROR_NAME_NOT_UNIQUE

regBASE_KEY

regGRAIL_KEY

sigON_ADD

sigON_CANCEL

sigON_CHANGE

sigON_CLICK

sigON_DOUBLE_CLICK

sigON_ERROR

sigON_KILLFOCUS

sigON_MAX_CHANGE

sigON_MIN_CHANGE

sigON_OK

sigON_REMOVE

sigON_RETURN

sigON_SELECT

sigON_STATE_CHANGE

sigON_TEXT_ENTRY_CHANGE

sigON_TOGGLE

strABOUT

strADD

strALL_FILES

strALPHANUM_STRING_ERR

strALPHA_STRING_ERR

strAPPLY

strARROW

strBROWSE

strCANCEL

strCONFIGURING_SYSTEM

strDEFAULT

strDEFAULT_INVALID_INPUT_MSG

strDESCRIPTION

strDIGIT_STRING_ERR

strDONE

strDOWN

strEXIT

strEXPAND_FOLDERS

strFILE

strFLOAT_ERR

strGO

strHELP

strINTEGER_ERR

strITEM_LIST_ERR

strITEM_LIST_ERR_NO_BLANKS

strLEFT

strLEN_STRING_ERR

strLOADING_WINDOW

strLOAD_VARS

strMINESIGHT_RESOURCES

strNATURAL_INTEGER_ERR

strNO

strOK

strOPEN

strOPTIONS

strPANEL_HELP

strPICKPROJFILE

strPROJECT_FILES

strRANGED_FLOAT_ERR

strRANGED_INTEGER_ERR

strREMOVE

strREPORTFILE

strRIGHT

strRUNFILE

strRUNFILEXTENSION

strSAVE_AS

strSAVE_AS_OVERRWRITE_MSG

strSAVE_MULTIRUN_SETUP

strSAVE_VARS

strSETUP

strSTRING_ERR

strUP

strVARIABLE_SETS

strYES