.. _GXSTR:

GXSTR class
==================================

.. autoclass:: geosoft.gxapi.GXSTR
   :members:

.. _FILE_EXT:

FILE_EXT constants
-----------------------------------------------------------------------

::

   Extension option 

.. autoattribute:: geosoft.gxapi.FILE_EXT_ADD_IF_NONE

::

   will add the extension only if no extension is present. 

.. autoattribute:: geosoft.gxapi.FILE_EXT_FORCE

::

   will cause a renaming of the file extension to the new extension. 

.. _STR_CASE:

STR_CASE constants
-----------------------------------------------------------------------

::

   Case sensitivity 

.. autoattribute:: geosoft.gxapi.STR_CASE_TOLERANT


.. autoattribute:: geosoft.gxapi.STR_CASE_SENSITIVE


.. _STR_ESCAPE:

STR_ESCAPE constants
-----------------------------------------------------------------------

::

   How to handle escape 

.. autoattribute:: geosoft.gxapi.ESCAPE_CONVERT

::

   Converts non-standard characters in a string to escape sequences. 

.. autoattribute:: geosoft.gxapi.ESCAPE_REPLACE

::

   Replaces escape sequences with original characters. 

.. _STR_FILE_PART:

STR_FILE_PART constants
-----------------------------------------------------------------------

::

   Parts of a path string 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_NAME

::

   File Name 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_EXTENSION

::

   Extension 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_DIRECTORY

::

   Directory 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_VOLUME

::

   Drive 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_QUALIFIERS

::

   Qualifiers 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_NAME_EXTENSION

::

   Name and the Extension together 

.. autoattribute:: geosoft.gxapi.STR_FILE_PART_FULLPATH_NO_QUALIFIERS

::

   Full name of file with no qualifiers 

.. _STR_JUSTIFY:

STR_JUSTIFY constants
-----------------------------------------------------------------------

::

   String justification style 

.. autoattribute:: geosoft.gxapi.STR_JUSTIFY_LEFT


.. autoattribute:: geosoft.gxapi.STR_JUSTIFY_CENTER


.. autoattribute:: geosoft.gxapi.STR_JUSTIFY_RIGHT


.. _STR_TRIM:

STR_TRIM constants
-----------------------------------------------------------------------

::

   What to trim 

.. autoattribute:: geosoft.gxapi.STR_TRIMRIGHT


.. autoattribute:: geosoft.gxapi.STR_TRIMLEFT


.. autoattribute:: geosoft.gxapi.STR_TRIMBOTH