======================
``grail.const`` module
======================

.. include:: ..\version.h
.. include:: ..\Library_Reference\lib-reference.h


.. contents:: Table of Contents
   :backlinks: top





--------
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,

  .. Python::

    from grail import const

or

  .. Python::
     
     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
---------


:dd:`FLOATING_POINT_TOLERANCE`

:dd:`MAX_FLOAT`

:dd:`colorBLACK`

:dd:`colorDISABLED_BACKGROUND`

:dd:`colorDISABLED_FOREGROUND`

:dd:`colorENABLED_BACKGROUND`

:dd:`colorENABLED_FOREGROUND`

:dd:`colorERROR_BACKGROUND`

:dd:`colorERROR_FOREGROUND`

:dd:`colorFORMAT_STRING`

:dd:`colorLIGHT_GREY`

:dd:`colorWHITE`

:dd:`colorWINDOW_GREY`

:dd:`environMEDEXE`

:dd:`environMETLIB`

:dd:`excPROGRAMMERS_ERROR`

:dd:`excRTVERROR_NAME_NOT_UNIQUE`

:dd:`regBASE_KEY`

:dd:`regGRAIL_KEY`

:dd:`sigON_ADD`

:dd:`sigON_CANCEL`

:dd:`sigON_CHANGE`

:dd:`sigON_CLICK`

:dd:`sigON_DOUBLE_CLICK`

:dd:`sigON_ERROR`

:dd:`sigON_KILLFOCUS`

:dd:`sigON_MAX_CHANGE`

:dd:`sigON_MIN_CHANGE`

:dd:`sigON_OK`

:dd:`sigON_REMOVE`

:dd:`sigON_RETURN`

:dd:`sigON_SELECT`

:dd:`sigON_STATE_CHANGE`

:dd:`sigON_TEXT_ENTRY_CHANGE`

:dd:`sigON_TOGGLE`

:dd:`strABOUT`

:dd:`strADD`

:dd:`strALL_FILES`

:dd:`strALPHANUM_STRING_ERR`

:dd:`strALPHA_STRING_ERR`

:dd:`strAPPLY`

:dd:`strARROW`

:dd:`strBROWSE`

:dd:`strCANCEL`

:dd:`strCONFIGURING_SYSTEM`

:dd:`strDEFAULT`

:dd:`strDEFAULT_INVALID_INPUT_MSG`

:dd:`strDESCRIPTION`

:dd:`strDIGIT_STRING_ERR`

:dd:`strDONE`

:dd:`strDOWN`

:dd:`strEXIT`

:dd:`strEXPAND_FOLDERS`

:dd:`strFILE`

:dd:`strFLOAT_ERR`

:dd:`strGO`

:dd:`strHELP`

:dd:`strINTEGER_ERR`

:dd:`strITEM_LIST_ERR`

:dd:`strITEM_LIST_ERR_NO_BLANKS`

:dd:`strLEFT`

:dd:`strLEN_STRING_ERR`

:dd:`strLOADING_WINDOW`

:dd:`strLOAD_VARS`

:dd:`strMINESIGHT_RESOURCES`

:dd:`strNATURAL_INTEGER_ERR`

:dd:`strNO`

:dd:`strOK`

:dd:`strOPEN`

:dd:`strOPTIONS`

:dd:`strPANEL_HELP`

:dd:`strPICKPROJFILE`

:dd:`strPROJECT_FILES`

:dd:`strRANGED_FLOAT_ERR`

:dd:`strRANGED_INTEGER_ERR`

:dd:`strREMOVE`

:dd:`strREPORTFILE`

:dd:`strRIGHT`

:dd:`strRUNFILE`

:dd:`strRUNFILEXTENSION`

:dd:`strSAVE_AS`

:dd:`strSAVE_AS_OVERRWRITE_MSG`

:dd:`strSAVE_MULTIRUN_SETUP`

:dd:`strSAVE_VARS`

:dd:`strSETUP`

:dd:`strSTRING_ERR`

:dd:`strUP`

:dd:`strVARIABLE_SETS`

:dd:`strYES`