GXGUI class

class geosoft.gxapi.GXGUI
These are graphical functions that typically create a
dialog-style window for a specific function. Examples include
file import wizards, and the Histogram and Scatter tools.
static browse_dir((str)arg1, (str)arg2, (str_ref)arg3) → int:
Browses for a specific directory.
Parameters:
  • arg1 (str) – Title of the Form
  • arg2 (str) – Default path (Can be “”)
  • arg3 (geosoft.gxapi.str_ref) – Result Path Buffer (default on input)
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

static color_form((int_ref)arg1, (int)arg2) → int:
Select a colour.
Parameters:
  • arg1 (geosoft.gxapi.int_ref) – Colour (modified)
  • arg2 (int) – Ask about C_TRANSPARENT if white is selected (1: yes, 0: no)?
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Colour value is set on input, and new value returned.
If the input colour type is C_TRANSPARENT, then the color
is set to white, if any other type is input the output is
guaranteed to be of the same type.

If the third flag is True is used, then on exit, if white is
selected, the user is prompted: 'Do you want white (Yes) or
"None" (No) ?' and the colour is converted as requested.
If this is not the case, the C_TRANSPARENT is converted
to white (if "Ok" is selected) and no choice is offered.
static color_transform((GXITR)arg1, (GXST)arg2) → int:
Define an ITR of up to 8 zones.
Parameters:
Returns:

0 if OK 1 if user cancels
Return type:

int

New in version 5.0.0.

Note:

The statistics object is required in order to determine
data ranges, percentiles, etc. Create it using
geosoft.gxapi.GXST.create_exact(), or be sure to enable histogram statistics.
static color_transform_ex((GXITR)arg1, (GXST)arg2, (int)arg3, (int)arg4, (str_ref)arg5) → int:
Define an ITR of up to 12 zones, with file load/save buttons.
Parameters:
Returns:

0 if OK 1 if user cancels
Return type:

int

New in version 5.0.0.

Note:

The statistics object is required in order to determine
data ranges, percentiles, etc. Create it using
geosoft.gxapi.GXST.create_exact(), or be sure to enable histogram statistics.
The colour transform file name is used as the default when the save
button is pushed, and is updated both after the load and save buttons
are pushed by the value input or selected by the user.
static coord_sys_wizard((GXIPJ)arg1, (int)arg2, (int)arg3, (str)arg4, (str)arg5) → int:
Launch the coordinate system definition/display GUI.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Launches the new GX.Net single-dialog coordinate system
definition dialog. The input IPJ is modified on return
if OK is selected (and the editable parameter is 1).
The "Data source label" and "Data source" is information displayed
in the dialog for the user to know where the IPJ came from (e.g. "Grid: X.grd")
static coord_sys_wizard_grid((GXIPJ)arg1, (GXIPJ)arg2, (int)arg3, (int)arg4, (str)arg5, (str)arg6, (int)arg7, (int)arg8, (float_ref)arg9, (float_ref)arg10, (float_ref)arg11, (float_ref)arg12, (float_ref)arg13) → int:
Launch the coordinate system definition/display GUI.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 9.0.0.

Note:

Same as geosoft.gxapi.GXGUI.coord_sys_wizard_licensed() but allows the original grid info to be adjusted
when projections on section or oriented plan grids are modified.
In the tool, it is the "modified" orientation required to keep the edited projection's grid
in the same location as it was in the target projection.
static coord_sys_wizard_licensed((GXIPJ)arg1, (int)arg2, (int)arg3, (str)arg4, (str)arg5) → int:
Launch the coordinate system definition/display GUI.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Same as geosoft.gxapi.GXGUI.coord_sys_wizard_licensed() but will always be editable. The other
method is not editable in the viewer while this one is.
static create_wnd_from_hwnd((HWND)arg1) → int:
Create a standard WND object from an HWND.
Parameters:arg1 (geosoft.gxapi.HWND) – HWND Handle
Returns:x - WND object created
Return type:int

New in version 5.0.0.

Note:

The object returned must be destroyed by the
destroy object call.
static cumulative_percent((str_ref)arg1, (GXITR)arg2) → int:
Define a percent-based ITR of up to 12 zones.
Parameters:
Returns:

0 if OK 1 if user cancels
Return type:

int

New in version 5.0.0.

Note:

The ITR values are interpreted as cumulative percent values, using
the "PERCENT=1" value in the ITR's REG.

Note that processes using ITRs do not automatically know to convert between
percent values and "actual" data values. The REG "PERCENT" value is simply
a flag to indicate to a user that the values are intended to be in the range
from 0 < x < 100. The ITR should not, therefore, be applied directly to data
unless that data is already given in percent.

If the file name is defined on input, the initial ITR will be loaded from it.
If it is left blank, a default 5-colour transform with
The colour transform file name is used as the default when the save
button is pushed, and is updated both after the load and save buttons
are pushed by the value input or selected by the user.
static dat_file_form((str)arg1, (str)arg2, (str_ref)arg3, (int)arg4, (int)arg5, (int)arg6) → int:
Grid and Image file Open/Save Form for Multiple/Single file selections
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Remember to make the string size big enough for multiple file
selections. In the case of multiple selections the names will be separated
by a semicolon and only the first file will contain the full path.

When using the multiple flag on any of these functions please be aware that
the string returned will be in the format:
drive:path1path2name.grid|name2.grid|name3.grid(QUALIFIERS)
All grids are required to be of the same type.
static database_type((str)arg1, (str_ref)arg2) → int:
Returns the type string of an external DAO database.
Parameters:
Returns:

0 - OK -1 - Cancel terminates on error
Return type:

int

New in version 5.0.0.

Note:

If the file extension is "mdb", then an MSJET (Microsoft Access)
database is assumed. If the file name is "ODBC", then "ODBC" is
returned as the type. Otherwise, a dialog appears listing the
other valid DAO database types.
static datamine_type((str)arg1, (int_ref)arg2) → int:
Returns the type of a Datamine file.
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Often, a Datamine file can be opened a number of different ways
(e.g. as a string file or a as wireframe (point) file.
The following function checks to see if there is a choice to be made
between types supported by Geosoft for import. If not, it just returns
the original type "hint" from Datamine. If there is a choice, it puts up
a dialog with the choices for the user to pick from.
Do a bit-wise AND with the returned type to determine the file type
(or the type selected).

Currently supported overlapping types/choices:

dmString
dmWireframePoint
static export_xyz_template_editor((GXDB)arg1, (str)arg2, (int)arg3) → int:
Allows the user to edit XYZ export template
using a complex dialog. The Template name
may change during editing.
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – Database
  • arg2 (str) – Name of the Template (can change)
  • arg3 (int) – Size of the Template
Returns:

0 - OK 1 - Error
Return type:

int

New in version 5.0.0.

Note:

Only uses the current DB. This function does
not exactly work as supposed to. Instead of using
the EDB handle passed to it, it only will use
the current DB. Please see ExportXYXTemplateEditorEx_GUI
for an updated function.
static export_xyz_template_editor_ex((GXEDB)arg1, (str_ref)arg2) → int:
Allows the user to edit an XYZ export template
using a complex dialog. The template name
may change during editing.
Parameters:
Returns:

0 - OK 1 - Error
Return type:

int

New in version 5.0.0.

Note:

Will use the EDB passed in. This function replaces
the 'buggy' function geosoft.gxapi.GXGUI.export_xyz_template_editor().
This extended function actually uses the EDB handle
passed to it and not just the current DB.
static fft2_spec_filter((str)arg1, (str)arg2) → None:
Interactive FFT2 radially averaged power spectrum filter
Parameters:
  • arg1 (str) – Name of the input spectrum file
  • arg2 (str) – Name of the output control file
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static file_filter_index((str)arg1) → int:
Return the FILE_FILTER_XXX value for a file filter string.
Parameters:arg1 (str) – Input filter string
Returns:FILE_FILTER constants, -1 if not found
Return type:int

New in version 7.0.0.

Note:

For example, if "Database (*.gdb)" is input,
then the FILE_FILTER_GDB value is returned.
static gcs_datum_warning_shp((str)arg1, (GXIPJ)arg2) → int:
Launch the GCS Datum Warning dialogue for SHP files.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 7.1.0.

Note:

Runs the GCS Warning dialogue with one data source
static gcs_datum_warning_shp_ex((GXLST)arg1, (GXLST)arg2, (GXLST)arg3, (GXMVIEW)arg4) → int:
Launch the GCS Datum Warning dialogue for SHP files.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 7.1.0.

Note:

Runs the GCS Warning dialogue with multiple data sources
static gcs_datum_warning_shpdb_ex((GXLST)arg1, (GXLST)arg2, (GXLST)arg3, (GXDB)arg4) → int:
Launch the GCS Datum Warning dialogue for SHP files (Database).
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 7.1.0.

Note:

Runs the GCS Warning dialogue with multiple data sources (Database)
static gen_file_form((str)arg1, (GXVV)arg2, (int)arg3, (str)arg4, (str_ref)arg5, (int)arg6, (int)arg7) → int:
General file Open/Save Form for Multiple/Single file selections and multiple filter capability
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Remember to make the string size big enough for multiple file
selections. In the case of multiple selections the names will be separated
by a semicolon and only the first file will contain the full path.

Defined Functions     The following four functions are handy defines and simply pass the appropriate
parameter.

iFileOpen_GUI
iFileSave_GUI
iMultiFileOpen_GUI
iMultiFileSave_GUI
static get_area_of_interest((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (GXPLY)arg5, (GXIPJ)arg6) → int:
Get the current area of interest from the application.
Parameters:
Returns:

AOI_RETURN_STATE constants
Return type:

int

New in version 5.0.0.

Note:

Depending on what is currently visible on screen and
the defined coordinate system the user may be prompted
by a warning and optionaly cancel the process.
static get_area_of_interest_3d((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (GXPLY)arg7, (GXIPJ)arg8) → int:
Get the current area of interest from the application in 3D.
Parameters:
Returns:

AOI_RETURN_STATE constants
Return type:

int

New in version 5.0.0.

Note:

Depending on what is currently visible on screen and
the defined coordinate system the user may be prompted
by a warning and optionaly cancel the process.
static get_client_window_area((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4) → None:
Get the location of the oasis montaj client window.
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

Note:

Returns the coordinates of the client window area (where MDI document windows are placed).
The returned coordinates are 0,0 for the minimum X and Y and the window width
width and height for the maximum X and Y.
static get_dat_defaults((int)arg1, (int)arg2, (str_ref)arg3, (str_ref)arg4) → None:
Return the user default extension and qualifier for grids/images.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

The default grid/image filters are normally stored in
"MONTAJ.DEFAULT_XGD_IN" and "MONTAJ.DEFAULT_XGD_OUT"

If no filter is defined, or the filter is not found
then "grd" and "GRD" are returned as the default extension
and qualifier.
static get_file_filter((int)arg1, (str_ref)arg2, (str_ref)arg3, (str_ref)arg4, (int_ref)arg5) → None:
Return the defined filter, mask, extension and directory for an input filter.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Returns the four parts of the file filter;
e.g. for FILE_FILTER_GDB it returns:

Filter:    "Database (*.gdb)"
Mask:      "*.gdb"
Extension: "gdb"
Directory: "GS_DIRECTORY_NONE"

This function is useful for constuction open/save dialog
file filters, especially in GX.Net functions.
static get_gs_directory((int)arg1, (str_ref)arg2) → None:
Return the directory path for value of GS_DIRECTORY.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.0.0.

Note:

Works along with the geosoft.gxapi.GXGUI.get_file_filter() function. Note that
most values of FILE_FILTER_XXX will return GS_DIRECTORY_NONE,
and give the current workspace directory.

This function is useful for constuction open/save dialog
file filters, especially in GX.Net functions.
static get_parent_wnd() → int:
Get the current parent window
Returns:Parent window.
Return type:int

New in version 5.0.0.

static get_printer_lst((GXLST)arg1) → None:
Gets a list of all printers.
Parameters:arg1 (geosoft.gxapi.GXLST) – List to place into
Returns:Nothing
Return type:None

New in version 5.0.0.

static get_window_position((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4, (int_ref)arg5) → None:
Get the oasis Montaj window's position state
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

static get_window_state() → int:
Retrieve the current state of the oasis Montaj window
Returns:WINDOW_STATE constants
Return type:int

New in version 9.0.0.

static grid_stat_hist((str)arg1) → None:
Display Histogram of grid
Parameters:arg1 (str) – Name of the grid to get stats from
Returns:Nothing
Return type:None

New in version 5.0.0.

static import_ascii_wizard((str)arg1, (str)arg2) → int:
Generate a template file from a gui.
Parameters:
  • arg1 (str) – data file name
  • arg2 (str) – template to make
Returns:

0 - OK 1 - Cancel
Return type:

int

New in version 5.0.0.

static import_chem_database((str)arg1, (str)arg2, (str_ref)arg3, (int)arg4) → int:
Generate a template file for importing Geochems Database.
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

static import_chem_database_ado((str)arg1, (str)arg2, (str_ref)arg3, (int)arg4) → int:
Improved template creation for importing geochem database (ADO).
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

This is an improved version of ImportChemDatabase_GUI using the
new ADO technology, as opposed to DAO. Use in conjuction with
geosoft.gxapi.GXDU.import_ado(). See also ImportDatabaseADO_GUI.
static import_chem_wizard((str)arg1, (str)arg2, (int)arg3) → None:
Generate a template file for importing geochems.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static import_database((str)arg1, (str)arg2, (str_ref)arg3) → int:
Create template to import an external database table.
Parameters:
  • arg1 (str) – External database file name
  • arg2 (str) – Template to make
  • arg3 (geosoft.gxapi.str_ref) – Name of table imported (returned)
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

This is used to select a single database table, and
selected fields from that table. If the database is not
Microsoft Access (type .mdb), an introductory dialog
requests the file type.
This function DOES NOT import the table itself, but
creates an import template which may be used to import
the table (see geosoft.gxapi.GXDU.import_dao()()).
static import_database_ado((str)arg1, (str)arg2, (str_ref)arg3) → int:
Create template to import an external database table (ADO Version).
Parameters:
  • arg1 (str) – External database connection string (Blank for OLEDB Wizard)
  • arg2 (str) – Template to make
  • arg3 (geosoft.gxapi.str_ref) – Name of table imported (returned)
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

1. This is used to select a single database table, and
   selected fields from that table.

2. This function DOES NOT import the table itself, but
   creates an import template which may be used to import
   the table (see geosoft.gxapi.GXDU.import_ado()()).

3. If connection string is of type "FILENAME=..." the connection will attempt to resolve
   it as a file database. (see also ODBCFileConnect_GUI)
static import_database_sql((str)arg1, (str)arg2, (str)arg3, (str_ref)arg4) → int:
Create template to import an external database table,
created using SQL.
Parameters:
  • arg1 (str) – External database file name
  • arg2 (str) – Text file with SQL queries to use, (“” - get from database)
  • arg3 (str) – Import template to make
  • arg4 (geosoft.gxapi.str_ref) – Name of table imported (returned)
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

1. This is used to build an Oasis montaj group (line) from
   one or more database tables and fields, by selecting from
   one or more SQL selection queries. The list of queries
   is read from a text file with the following syntax:

   Query_Name_1
   Query...
   Query... (continued)
   ...
   ...
   END_QUERY
   Query_Name_2
   etc.

2. Each query has a title line, the query itself, then the
   "END_QUERY" line to finish.  The title of a subsequent query
   is on the line after an "END_QUERY" line.

3. If the text file parameter is left blank (""), then
   selection queries in the database itself are listed.
   In addition to the pre-defined queries, there is a
   "User Defined" query which may be filled in by the user.

4. This function DOES NOT import the table itself, but
   creates an import template which may be used to import
   the data (see geosoft.gxapi.GXDU.import_dao()()).

5. If connection string is of type "FILENAME=..." the connection will attempt to resolve
   it as a file database. (see also ODBCFileConnect_GUI)
static import_database_sqlado((str)arg1, (str)arg2, (str)arg3, (str_ref)arg4) → int:
Create template to import an external database table,
created using SQL (New ADO Version).
Parameters:
  • arg1 (str) – External database connection string (Blank for OLEDB Wizard)
  • arg2 (str) – Text file with SQL queries to use, (“” - get from database)
  • arg3 (str) – Import template to make
  • arg4 (geosoft.gxapi.str_ref) – Name of table imported (returned)
Returns:

0 - OK -1 Cancel
Return type:

int

New in version 5.0.0.

Note:

This is used to build an Oasis montaj group (line) from
one or more database tables and fields, by selecting from
one or more SQL selection queries. The list of queries
is read from a text file with the following syntax:

Query_Name_1
Query...
Query... (continued)
...
...
END_QUERY
Query_Name_2
etc.

Each query has a title line, the query itself, then the
"END_QUERY" line to finish.  The title of a subsequent query
is on the line after an "END_QUERY" line.

If the text file parameter is left blank (""), then
selection queries in the database itself are listed.
In addition to the pre-defined queries, there is a
"User Defined" query which may be filled in by the user.

This function DOES NOT import the table itself, but
creates an import template which may be used to import
the data (see geosoft.gxapi.GXDU.import_dao()()).
static import_drill_database_ado((str)arg1, (str)arg2, (str_ref)arg3, (int_ref)arg4, (GXREG)arg5) → int:
Generate a template file for importing drill holes.
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

This is an improved version of ImportDrillDatabase_GUI using the
new ADO technology, as opposed to DAO. Use in conjuction with
geosoft.gxapi.GXDU.import_ado(). See also ImportDatabaseADO_GUI.
static import_drill_database_ado2((str)arg1, (str_ref)arg2, (str_ref)arg3, (int_ref)arg4, (GXREG)arg5) → int:
Same as geosoft.gxapi.GXGUI.import_drill_database_ado(), but template name is returned.
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

If it is not defined on input, the template name is set
to be the Wholeplot table name; e.g.
"HOLESURVEY.i4" for "Project_HOLESURVEY"
static import_drill_database_esri((str)arg1, (str_ref)arg2, (str_ref)arg3, (int_ref)arg4, (bool)arg5, (GXREG)arg6) → int:
Same as iImportDrillDatabaseADO2_GUI, but from an ArcGIS Geodatabase
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

If it is not defined on input, the template name is set
to be the Wholeplot table name; e.g.
"HOLESURVEY.i4" for "Project_HOLESURVEY"
static import_drill_database_odbc((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (int_ref)arg4, (GXREG)arg5) → int:
Generate a template file for importing drill holes
from ODBC database data.
Parameters:
Returns:

0 - OK -1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

If the input connection string is empty (""), then the ODBC connection dialogs
will appear (e.g. to connect to a machine database) before the import wizard
is run. The connect string used for this connection is then returned.
This string can then be used on input to skip the ODBC connection dialogs and
go straight to the Wholeplot import wizard.
Because the name of the database is not necessarily known, the template name is created
from the name of the table opened - e.g. "HOLELOCATION.i4".
static import_drill_database_odbc_maxwell((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (int_ref)arg4, (GXREG)arg5) → int:
Same as geosoft.gxapi.GXGUI.import_drill_database_odbc() but customized for Maxwell.
Parameters:
Returns:

0-OK 1-Cancel
Return type:

int

New in version 8.3.0.

Note:

Same as geosoft.gxapi.GXGUI.import_drill_database_odbc() but customized for Maxwell.
static import_drill_wizard((str)arg1, (str)arg2, (str)arg3, (int)arg4, (int_ref)arg5, (GXREG)arg6) → None:
Generate a template file for importing drill holes.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static import_template_sql((str)arg1, (str)arg2, (str)arg3, (str)arg4) → int:
Create template to import an external database table; provide query.
Parameters:
  • arg1 (str) – External database file name
  • arg2 (str) – Import template to make
  • arg3 (str) – SQL selection query to run on database
  • arg4 (str) – Name of Oasis table to create
Returns:

0 - OK -1 Cancel terminates on error
Return type:

int

New in version 5.0.0.

Note:

This is similar to ImportDatabaseSQL_GUI, but dispenses with
the dialog offering a selection of queries. Instead, the
user supplies the query as a string.

This function DOES NOT import the table itself, but
creates an import template which may be used to import
the data (see geosoft.gxapi.GXDU.import_dao()()).
static import_template_sqlado((str)arg1, (str)arg2, (str)arg3, (str)arg4) → int:
Create template to import an external database table; provide query.
Parameters:
  • arg1 (str) – External database connection string (Blank for OLEDB Wizard)
  • arg2 (str) – Import template to make
  • arg3 (str) – SQL selection query to run on database
  • arg4 (str) – Name of Oasis table to create
Returns:

0 - OK -1 - Cancel terminates on error
Return type:

int

New in version 5.0.0.

Note:

This is similar to ImportDatabaseSQL_GUI, but dispenses with
the dialog offering a selection of queries. Instead, the
user supplies the query as a string.

This function DOES NOT import the table itself, but
creates an import template which may be used to import
the data (see geosoft.gxapi.GXDU.import_ado()()).
static import_xyz_template_editor((GXDB)arg1, (str)arg2, (int)arg3, (str)arg4) → int:
Allows the user to edit XYZ import templates
using a complex dialog. The Template name
may change during editing.
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – Database
  • arg2 (str) – Name of the Template (can change)
  • arg3 (int) – Size of the Template
  • arg4 (str) – Name of the XYZ file to base it on
Returns:

0 - OK 1 - Error
Return type:

int

New in version 5.0.0.

static internet_trust() → None:
Change the Internet Trust Relationships
Returns:Nothing
Return type:None

New in version 5.0.0.

static launch_geo_dotnetx_tool((str)arg1, (str)arg2, (GXMETA)arg3) → None:
Launch a user created .Net GEOXTOOL.
Parameters:
  • arg1 (str) – Assembly name
  • arg2 (str) – Control Class Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static launch_geo_dotnetx_tool_ex((str)arg1, (str)arg2, (GXMETA)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Launch a user created .Net GEOXTOOL.
Parameters:
  • arg1 (str) – Assembly name
  • arg2 (str) – Control Class Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
  • arg4 (int) – XTOOL_ALIGN constants (can specify one or more or XTOOL_ALIGN_ANY)
  • arg5 (int) – XTOOL_DOCK constants
  • arg6 (int) – Default width
  • arg7 (int) – Default height
Returns:

Nothing
Return type:

None

New in version 9.0.0.

static launch_geo_x_tool((str)arg1, (str)arg2, (GXMETA)arg3) → None:
Launch a user created GEOXTOOL.
Parameters:
  • arg1 (str) – DLL name
  • arg2 (str) – Function Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static launch_geo_x_tool_ex((str)arg1, (str)arg2, (GXMETA)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Launch a user created GEOXTOOL.
Parameters:
  • arg1 (str) – DLL name
  • arg2 (str) – Function Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
  • arg4 (int) – XTOOL_ALIGN constants (can specify one or more or XTOOL_ALIGN_ANY)
  • arg5 (int) – XTOOL_DOCK constants
  • arg6 (int) – Default width
  • arg7 (int) – Default height
Returns:

Nothing
Return type:

None

New in version 9.0.0.

static launch_single_geo_dotnetx_tool((str)arg1, (str)arg2, (GXMETA)arg3) → None:
Launch a user created .Net GEOXTOOL ensuring a single instance.
Parameters:
  • arg1 (str) – Assembly name
  • arg2 (str) – Control Class Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static launch_single_geo_dotnetx_tool_ex((str)arg1, (str)arg2, (GXMETA)arg3, (int)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Launch a user created .Net GEOXTOOL ensuring a single instance.
Parameters:
  • arg1 (str) – Assembly name
  • arg2 (str) – Control Class Name
  • arg3 (geosoft.gxapi.GXMETA) – META Handle (holding tool configuration data)
  • arg4 (int) – XTOOL_ALIGN constants (can specify one or more or XTOOL_ALIGN_ANY)
  • arg5 (int) – XTOOL_DOCK constants
  • arg6 (int) – Default width
  • arg7 (int) – Default height
Returns:

Nothing
Return type:

None

New in version 9.0.0.

static line_pattern_form((int_ref)arg1, (float_ref)arg2, (float_ref)arg3, (int_ref)arg4) → int:
Select a line pattern.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 8.1.0.

Note:

Same as geosoft.gxapi.GXGUI.pattern_form() but for line patterns.
static meta_data_tool((GXMETA)arg1, (int)arg2, (int)arg3) → int:
Edit a META object
Parameters:
  • arg1 (geosoft.gxapi.GXMETA) – Meta object
  • arg2 (int) – Root Token, H_META_INVALID_TOKEN for root
  • arg3 (int) – Display schema information ?
Returns:

0 - OK non-zero - Cancel
Return type:

int

New in version 5.0.0.

static meta_data_viewer((GXMETA)arg1, (int)arg2, (int)arg3) → None:
View a META object
Parameters:
  • arg1 (geosoft.gxapi.GXMETA) – Meta object
  • arg2 (int) – Root Token, H_META_INVALID_TOKEN for root
  • arg3 (int) – Display schema information ?
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static odbc_file_connect((str)arg1, (str_ref)arg2, (int)arg3, (str_ref)arg4) → int:
Get the connection string for a file database as well as optional table name and FileUsage attribute
Parameters:
  • arg1 (str) – File Name
  • arg2 (geosoft.gxapi.str_ref) – Connection string (returned)
  • arg3 (int) – File Usage (0 - ODBC drivers not queried, 1 - Directory containing tables, 2 - File containing tables)
  • arg4 (geosoft.gxapi.str_ref) – Table name of file (returned if plUsage==1)
Returns:

0 - OK -1 - Cancel terminates on error
Return type:

int

New in version 5.0.0.

Note:

If the file extension is "mdb" or "xls" then a Microsoft Access
or Excel database is assumed. Otherwise, a dialog appears listing
the installed ODBC file database drivers. If the driver takes a
directory as a database (FileUsage==1) the table name is also
returned. This is needed because the table name may or may not include
the file extension.
static pattern_form((int_ref)arg1, (float_ref)arg2, (int_ref)arg3, (float_ref)arg4, (int_ref)arg5, (int_ref)arg6) → int:
- Select a pattern.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Pattern values set on input, and new values returned.
Solid fill is indicated by Pattern number 0.

Returned Values (not set on input)

Size:    pattern tile size in mm.
Thick:   pattern line thickness in percent of the tile size.
         valid range is 0-100.
Density: Tile spacing. A value of 1 means tiles are laid with no overlap.
         A value of 2 means they overlap each other.

The pattern Angle and Style parameters are not user-definable.
static print_file((str)arg1) → None:
Prints a file to current printer
Parameters:arg1 (str) – Filename string
Returns:Nothing
Return type:None

New in version 5.0.0.

static render_line_pattern((HDC)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (float)arg7, (float)arg8, (int)arg9, (int)arg10, (int)arg11, (int)arg12) → None:
Render a line pattern.
Parameters:
  • arg1 (geosoft.gxapi.HDC) – DC Handle
  • arg2 (int) – left value of the render rect in Windows coordinates (bottom>top)
  • arg3 (int) – bottom value
  • arg4 (int) – right value
  • arg5 (int) – top value
  • arg6 (int) – pattern number
  • arg7 (float) – pattern thickness
  • arg8 (float) – pattern pitch
  • arg9 (int) – pattern colour
  • arg10 (int) – is this window enabled?
  • arg11 (int) – is this a button?
  • arg12 (int) – is this window selected?
Returns:

Nothing
Return type:

None

New in version 8.1.0.

Note:

Same as geosoft.gxapi.GXGUI.render_pattern() but for line patterns.
static render_pattern((HDC)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6, (float)arg7, (int)arg8, (float)arg9, (int)arg10, (int)arg11, (int)arg12, (int)arg13, (int)arg14) → None:
- Render a pattern.
Parameters:
  • arg1 (geosoft.gxapi.HDC) – DC Handle
  • arg2 (int) – left value of the render rect in Windows coordinates (bottom>top)
  • arg3 (int) – bottom value
  • arg4 (int) – right value
  • arg5 (int) – top value
  • arg6 (int) – pattern number
  • arg7 (float) – pattern Size, // input GS_R8DM to use default
  • arg8 (int) – pattern Thick (0-100) // input GS_S4DM to use default
  • arg9 (float) – pattern Density, // input GS_R8DM to use default
  • arg10 (int) – pattern Pattern Color // input GS_S4DM to use default
  • arg11 (int) – pattern Background Color // input GS_S4DM to use default; can be C_TRANSPARENT
  • arg12 (int) – is this window enabled?
  • arg13 (int) – is this a button?
  • arg14 (int) – is this window selected?
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Renders a Geosoft pattern to a Windows DC.
static set_parent_wnd((int)arg1) → None:
Set the current parent WND
Parameters:arg1 (int) – New Parent Window
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The parent WND is used by all modal dialogs as a
parent to ensure the dialog is correctly modal.
static set_printer((str)arg1) → None:
Sets the Printer.
Parameters:arg1 (str) – Printer Name
Returns:Nothing
Return type:None

New in version 5.0.0.

static set_prog_always_on((bool)arg1) → None:
Ability to set the progress bar to stay visible even
if main application is processing messages
Parameters:arg1 (bool) – bool Should progress bar remain visible
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

In montaj the progress bar is hidden when the main window
start processing messages. This is not always desirable
in some 3rd party apps, hence this function.
static set_window_position((int)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5) → None:
Get the oasis Montaj window's position and state
Parameters:
  • arg1 (int) – Window left position
  • arg2 (int) – Window top position
  • arg3 (int) – Window right position
  • arg4 (int) – Window bottom position
  • arg5 (int) – Window state WINDOW_STATE constants
Returns:

Nothing
Return type:

None

New in version 9.0.0.

static set_window_state((int)arg1) → None:
Changes the state of the oasis Montaj window
Parameters:arg1 (int) – WINDOW_STATE constants
Returns:Nothing
Return type:None

New in version 9.0.0.

static show_direct_hist((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (int)arg6, (GXVV)arg7) → None:
Display Histogram of data directly
Parameters:
  • arg1 (float) – Min Value to display
  • arg2 (float) – Max Value to display
  • arg3 (float) – Mean Value to display
  • arg4 (float) – StdDev Value to display
  • arg5 (float) – Median Value to display
  • arg6 (int) – Items Number of items this comprises
  • arg7 (geosoft.gxapi.GXVV) – VV holding hist counts
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static show_hist((GXST)arg1) → None:
Display Histogram of data from ST
Parameters:arg1 (geosoft.gxapi.GXST) – Statistics obj
Returns:Nothing
Return type:None

New in version 5.0.0.

static simple_map_dialog((GXMAP)arg1, (str)arg2, (str)arg3) → None:
General purpose map display GUI with no interaction.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This function displays a map in a simple resizable dialog that fits the map into it.
It is generally useful to display temporary maps as graphs (e.g. variograms).
static symbol_form((str_ref)arg1, (bool_ref)arg2, (int_ref)arg3, (int_ref)arg4, (float_ref)arg5, (float_ref)arg6, (int_ref)arg7, (int_ref)arg8) → int:
- Select a symbol.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Symbols are set on input, and new values returned.
static thematic_voxel_info((GXVOX)arg1) → None:
Display GX.Net thematic voxel info GUI.
Parameters:arg1 (geosoft.gxapi.GXVOX) – VOX object
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Displays the thematic voxel codes, colours, total volume for
each code, and number of valid items (cubes) for each code.
This is a replacement for the numeric stats done on normal
numerical voxel grids.
static two_panel_selection((GXLST)arg1, (GXLST)arg2, (str)arg3) → int:
General purpose two-panel selection.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Takes as input two LSTs, one contains all available items,
the second currently selected items. These are processed,
and in the left panel are displayed all items in the first
LST not in the selection LST, and on the right all items
in the first LST which are in the selection LST. (Items in
the selection LST NOT in the first LST are ignored).
Once the user has finalized the selections, the final selections
are returned in the selection LST.

Selections and display are based on the LST_ITEM_NAME part of the
LST item, but on export both the LST_ITEM_NAME and LST_ITEM_VALUE
elements of the selected items from the first LST are transferred
to the second list for output.

The sConvertToCSV_LST and sConvertFromCSV_LST functions in lst.h
can be used to convert the selection LSTs to forms that can be
stored and retrieved from GX parameters (or REG or INI, etc.).
static two_panel_selection2((GXLST)arg1, (GXLST)arg2, (str)arg3) → int:
Two-panel selection, items not sorted alphabetically.
Parameters:
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Same as geosoft.gxapi.GXGUI.two_panel_selection(), but the items in the
two lists are not sorted alphabetically, but are ordered
exactly as input, and when an item is selected it is
added at the end of the lists.
static two_panel_selection_ex((GXLST)arg1, (GXLST)arg2, (int)arg3, (int)arg4, (str)arg5) → int:
Two-panel selection; options for sort and ability to select no items.
Parameters:
  • arg1 (geosoft.gxapi.GXLST) – All available items for selection.
  • arg2 (geosoft.gxapi.GXLST) – Selections (altered on output)
  • arg3 (int) – Sort items alphabetically (0:No, 1:Yes)
  • arg4 (int) – Allow no items selected (0:No, 1:Yes)
  • arg5 (str) – Title for dialog
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Same as geosoft.gxapi.GXGUI.two_panel_selection(), but the items in the
two lists are not sorted alphabetically, but are ordered
exactly as input, and when an item is selected it is
added at the end of the lists.
static two_panel_selection_ex2((GXLST)arg1, (GXLST)arg2, (int)arg3, (int)arg4, (str)arg5, (str)arg6) → int:
Two-panel selection; extended options including a help link.
Parameters:
  • arg1 (geosoft.gxapi.GXLST) – All available items for selection.
  • arg2 (geosoft.gxapi.GXLST) – Selections (altered on output)
  • arg3 (int) – Sort items alphabetically (0:No, 1:Yes)
  • arg4 (int) – Allow no items selected (0:No, 1:Yes)
  • arg5 (str) – Title for dialog
  • arg6 (str) – Help link
Returns:

0 - Ok 1 - Cancel
Return type:

int

New in version 5.0.0.

Note:

Same as geosoft.gxapi.GXGUI.two_panel_selection_ex(), but user can specify a help
link.
static voxel_stat_hist((str)arg1) → None:
Display Histogram of Voxel
Parameters:arg1 (str) – Name of the Voxel to get stats from
Returns:Nothing
Return type:None

New in version 5.0.0.

AOI_RETURN_STATE constants

AOI Query Return State
gxapi.AOI_RETURN_CANCEL = -1
User Canceled
gxapi.AOI_RETURN_NODEFINE = 0
User chose to continue with no AOI defined or available
gxapi.AOI_RETURN_DEFINE = 1
User chose to continue and defined valid AOI parameters

COORDSYS_MODE constants

Coordinate system wizard IPJ types allowed on return.
The wizard present three types of projections for selection
by the user, Geographic (GCS), Projected (PCS), and Unknown.
(Unknown requires only that the units be defined.)
The Editable flag must be Yes for this option to take affect,
and is overridden internally if the user's license does not
allow modification of projections (e.g. the OM Viewer).
gxapi.COORDSYS_MODE_ALL = 0
Allow Geographic (GCS), Projected (PCS), and Unknown
gxapi.COORDSYS_MODE_GCS = 1
Allow only Geographic (GCS)
gxapi.COORDSYS_MODE_PCS = 2
Allow only Projected (PCS)
gxapi.COORDSYS_MODE_GCS_PCS = 3
Allow only Geographic (GCS) and Projected (PCS)
gxapi.COORDSYS_MODE_PCS_UNKNOWN = 4
Allow only Projected (PCS), or Unknown

DAT_TYPE constants

Type of files (grids, images) to support
gxapi.DAT_TYPE_GRID = 0
Display only grid formats
gxapi.DAT_TYPE_IMAGE = 1
Display only image formats
gxapi.DAT_TYPE_GRID_AND_IMAGE = 2
Displays both grids and image formats

FILE_FILTER constants

File Filters
gxapi.FILE_FILTER_ALL = 1
All Files              \ `*`\ .\ `*`\                   ANYWHERE
gxapi.FILE_FILTER_GDB = 2
Geosoft Database       \ `*`\ .gdb                LOCAL
gxapi.FILE_FILTER_GX = 3
Geosoft Executable     \ `*`\ .gx                 GEOSOFT
gxapi.FILE_FILTER_GS = 4
Geosoft Script         \ `*`\ .gs                 BOTH
gxapi.FILE_FILTER_INI = 5
Parameter Files        \ `*`\ .ini                GEOSOFT
gxapi.FILE_FILTER_OMN = 6
Oasis Menu Files       \ `*`\ .omn                GEOSOFT
gxapi.FILE_FILTER_VU = 7
Oasis View Files       \ `*`\ .vu                 LOCAL
gxapi.FILE_FILTER_MAP = 8
Oasis Map Files        \ `*`\ .map                LOCAL
gxapi.FILE_FILTER_PRJ = 9
Projection File        \ `*`\ .prj                LOCAL
gxapi.FILE_FILTER_CON = 10
Configuration File     \ `*`\ .con                LOCAL
gxapi.FILE_FILTER_MNU = 11
Sushi MNU Files        \ `*`\ .mnu                GEOSOFT
gxapi.FILE_FILTER_PDF = 12
PDF Files              \ `*`\ .pdf                GEOSOFT
gxapi.FILE_FILTER_PLT = 13
Geosoft PLT files      \ `*`\ .plt                LOCAL
gxapi.FILE_FILTER_GWS = 14
Geosoft workspace      \ `*`\ .gws                LOCAL
gxapi.FILE_FILTER_AGG = 15
Aggregate              \ `*`\ .agg                LOCAL
gxapi.FILE_FILTER_TBL = 16
Color Table            \ `*`\ .tbl                GEOSOFT
gxapi.FILE_FILTER_ZON = 17
Zone                   \ `*`\ .zon                LOCAL
gxapi.FILE_FILTER_ITR = 18
Image transform        \ `*`\ .itr                LOCAL
gxapi.FILE_FILTER_DXF = 19
AutoCAD DXF files      \ `*`\ .dxf                LOCAL
gxapi.FILE_FILTER_TIF = 20
TIFF files             \ `*`\ .tif                LOCAL
gxapi.FILE_FILTER_EMF = 21
Enhanced Metafies      \ `*`\ .emf                LOCAL
gxapi.FILE_FILTER_BMP = 22
Bitmap files           \ `*`\ .bmp                LOCAL
gxapi.FILE_FILTER_LUT = 23
ER Mapper LUT          \ `*`\ .lut                GEOSOFT
gxapi.FILE_FILTER_PNG = 24
PNG Files              \ `*`\ .png                LOCAL
gxapi.FILE_FILTER_JPG = 25
JPG Files              \ `*`\ .jpg                LOCAL
gxapi.FILE_FILTER_PCX = 26
PCX Files              \ `*`\ .pcx                LOCAL
gxapi.FILE_FILTER_GIF = 27
GIF Files              \ `*`\ .gif                LOCAL
gxapi.FILE_FILTER_GRD = 28
GRD Files              \ `*`\ .grd                LOCAL
gxapi.FILE_FILTER_ERS = 29
ERS Files              \ `*`\ .ers                LOCAL
gxapi.FILE_FILTER_EPS = 30
EPS Files              \ `*`\ .eps                LOCAL
gxapi.FILE_FILTER_SHP = 31
ArcView Shape Files    \ `*`\ .shp                LOCAL
gxapi.FILE_FILTER_CGM = 32
CGM Files              \ `*`\ .cgm                LOCAL
gxapi.FILE_FILTER_TAB = 33
MapInfo Tab Files      \ `*`\ .tab                LOCAL
gxapi.FILE_FILTER_COMPS = 34
Software Components    Components           LOCAL
gxapi.FILE_FILTER_CSV = 35
MapInfo Tab Files      \ `*`\ .tab                LOCAL
gxapi.FILE_FILTER_GPF = 36
Geosoft Project        \ `*`\ .gpf                LOCAL
gxapi.FILE_FILTER_PLY = 37
Geosoft Polygons       \ `*`\ .ply                LOCAL
gxapi.FILE_FILTER_STM = 38
Scatter templates      \ `*`\ .stm                LOCAL
gxapi.FILE_FILTER_TTM = 39
Triplot templates      \ `*`\ .ttm                LOCAL
gxapi.FILE_FILTER_XYZ = 40
Geosoft XYZ Files      \ `*`\ .xyz                LOCAL
gxapi.FILE_FILTER_BAR = 41
Geosoft Bar File       \ `*`\ .geobar             LOCAL
gxapi.FILE_FILTER_GEOSOFT_LICENSE = 42
Geosoft License Files   \ `*`\ .geosoft_license   LOCAL
gxapi.FILE_FILTER_XML = 43
XML Files              \ `*`\ .xml                LOCAL
gxapi.FILE_FILTER_GXNET = 44
GX.NET Files           \ `*`\ .dll                GEOSOFT
gxapi.FILE_FILTER_ECW = 45
ECW Files              \ `*`\ .ecw                LOCAL
gxapi.FILE_FILTER_J2K = 46
J2K JPEG 2000 Files    \ `*`\ .j2k                LOCAL
gxapi.FILE_FILTER_JP2 = 47
JP2 JPEG 2000 Files    \ `*`\ .jp2                LOCAL
gxapi.FILE_FILTER_SEL = 48
acQuire parameters     \ `*`\ .sel                LOCAL
gxapi.FILE_FILTER_SVG = 49
SVG File               \ `*`\ .svg                LOCAL
gxapi.FILE_FILTER_SVZ = 50
SVG Compressed File    \ `*`\ .svz                LOCAL
gxapi.FILE_FILTER_WRP = 51
Warp File              \ `*`\ .wrp                LOCAL
gxapi.FILE_FILTER_MAPPLOT = 52
MAPPLOT File           \ `*`\ .con                LOCAL
gxapi.FILE_FILTER_DTM = 53
Surpac DTM Files       \ `*`\ .dtm                LOCAL
gxapi.FILE_FILTER_VOXEL = 54
Geosoft Voxel          \ `*`\ .geosoft_voxel      LOCAL
gxapi.FILE_FILTER_MAPTEMPLATE = 55
Map Template File      \ `*`\ .geosoft_maptemplate      LOCAL
gxapi.FILE_FILTER_ACTION = 56
Action Scripts         \ `*`\ .action             LOCAL
gxapi.FILE_FILTER_DM = 57
Datamine files         \ `*`\ .dm                 LOCAL
gxapi.FILE_FILTER_KML = 58
Google Earth KML       \ `*`\ .kml                LOCAL
gxapi.FILE_FILTER_KMZ = 59
Google Earth Compressed KML  \ `*`\ .kmz          LOCAL
gxapi.FILE_FILTER_TARGET_PLAN = 60
Target parameter ini file for plans      \ `*`\ .inp    LOCAL
gxapi.FILE_FILTER_TARGET_SECTION = 61
Target parameter ini file for sections   \ `*`\ .ins    LOCAL
gxapi.FILE_FILTER_TARGET_STRIPLOG = 62
Target parameter ini file for strip logs \ `*`\ .inl    LOCAL
gxapi.FILE_FILTER_TARGET_3D = 63
Target parameter ini file for 3D plots   \ `*`\ .in3    LOCAL
gxapi.FILE_FILTER_ARGIS_LYR = 64
ArcGIS Layer Files                    \ `*`\ .lyr    LOCAL
gxapi.FILE_FILTER_ARGIS_MXD = 65
ArcGIS Map Document Files     \ `*`\ .mxd    LOCAL
gxapi.FILE_FILTER_GOCAD_TS = 66
GOCAD TSurf Files                     \ `*`\ .ts     LOCAL
gxapi.FILE_FILTER_LST = 67
Geosoft list of items: names, values  \ `*`\ .lst     LOCAL
gxapi.FILE_FILTER_ECS = 68
GM-SYS Extern Coord Sys \ `*`\ .ecs               LOCAL
gxapi.FILE_FILTER_TARGET_FENCE = 69
Target parameter ini file for fence sections   \ `*`\ .ins    LOCAL
gxapi.FILE_FILTER_GMS3D = 70
GMSYS 3D Model \ `*`\ .geosoft_gms3d LOCAL
gxapi.FILE_FILTER_BT2 = 71
GEMCOM BT2 \ `*`\ .bt2 LOCAL
gxapi.FILE_FILTER_BPR = 72
GEMCOM BPR \ `*`\ .bpr LOCAL
gxapi.FILE_FILTER_BPR2 = 73
GEMCOM BPR2 \ `*`\ .bpr2 LOCAL
gxapi.FILE_FILTER_XLS = 74
Excel 97-2003 Workbook               \ `*`\ .xls                                     LOCAL
gxapi.FILE_FILTER_XLSX = 75
Excel 2007 Workbook                  \ `*`\ .xlsx                            LOCAL
gxapi.FILE_FILTER_MDB = 76
Access 97-2003                               \ `*`\ .mdb                             LOCAL
gxapi.FILE_FILTER_ACCDB = 77
Access 2007                                  \ `*`\ .accdb                           LOCAL
gxapi.FILE_FILTER_INTERSECTION_TBL = 78
Levelling intersection               \ `*`\ .tbl                                     LOCAL
gxapi.FILE_FILTER_UBC_CON = 79
UBC DCIP2D Conductivity model files \ `*`\ .con              LOCAL
gxapi.FILE_FILTER_UBC_CHG = 80
UBC DCIP2D Chargeability model files \ `*`\ .chg     LOCAL
gxapi.FILE_FILTER_UBC_MSH = 81
UBC DCIP2D Mesh files                \ `*`\ .msh                                     LOCAL
gxapi.FILE_FILTER_UBC_MSH_DAT = 82
UBC DCIP2D Mesh files                \ `*`\ .dat                                     LOCAL
gxapi.FILE_FILTER_UBC_TOPO_DAT = 83
UBC DCIP2D Topo files                \ `*`\ .dat                                     LOCAL
gxapi.FILE_FILTER_UBC_TOPO_XYZ = 84
UBC DCIP2D Topo files                \ `*`\ .xyz                                     LOCAL
gxapi.FILE_FILTER_XYZ_TEMPLATE_I0 = 85
XYZ Import Templates               \ `*`\ .i0                                LOCAL
gxapi.FILE_FILTER_PICO_TEMPLATE_I1 = 86
Picodas Import Templates      \ `*`\ .i1                             LOCAL
gxapi.FILE_FILTER_BB_TEMPLATE_I2 = 87
Block Binary Import Templates \ `*`\ .i2                             LOCAL
gxapi.FILE_FILTER_ASCII_TEMPLATE_I3 = 88
ASCII Import Templates                  \ `*`\ .i3                           LOCAL
gxapi.FILE_FILTER_ODBC_TEMPLATE_I4 = 89
ODBC Import Templates                   \ `*`\ .i4                           LOCAL
gxapi.FILE_FILTER_EXP = 90
Math expression files                   \ `*`\ .exp                          LOCAL
gxapi.FILE_FILTER_SEGY = 91
SEGY files                                                   \ `*`\ .sgy                     LOCAL
gxapi.FILE_FILTER_DAARC500 = 92
DAARC500 files                                               xYYMMDD                    LOCAL
gxapi.FILE_FILTER_TXT = 93
Text files                                                   \ `*`\ .txt                     LOCAL
gxapi.FILE_FILTER_VOXEL_INVERSION = 94
Voxi                                                                 \ `*`\ .geosoft_voxi    LOCAL
gxapi.FILE_FILTER_GMS = 95
GM-SYS                                                                       \ `*`\ .gms     LOCAL
gxapi.FILE_FILTER_FLT3D = 96
Geosoft 3D filter Files                      \ `*`\ .flt3d                   LOCAL
gxapi.FILE_FILTER_RESOURCE_PACK = 97
Geosoft Resource Update Packages \ `*`\ .geosoft_resource_pack LOCAL
gxapi.FILE_FILTER_GEOSTRING = 98
Geostring Files \ `*`\ .geosoft_string LOCAL
gxapi.FILE_FILTER_GEOSURFACE = 99
Geosurface Files \ `*`\ .geosoft_surface LOCAL
gxapi.FILE_FILTER_GEOSOFT3DV = 100
Geosoft 3DV \ `*`\ .geosoft_3dv LOCAL
gxapi.FILE_FILTER_VECTORVOXEL = 101
Geosoft Vector Voxel \ `*`\ .geosoft_vectorvoxel LOCAL
gxapi.FILE_FILTER_FLT = 102
Geosoft Filters \ `*`\ .flt LOCAL
gxapi.FILE_FILTER_XYZ_TEMPLATE_O0 = 103
XYZ Export Templates \ `*`\ .o0 LOCAL
gxapi.FILE_FILTER_GMS2D = 104
GMSYS 2D Model \ `*`\ .geosoft_gms2d LOCAL
gxapi.FILE_FILTER_IP_DATABASE_TEMPLATE = 105
IP Database Template \ `*`\ .geosoft_ipdatabasetemplate LOCAL
gxapi.FILE_FILTER_GEOSOFT_RESOURCE_MODULE = 106
Geosoft Resource Module \ `*`\ .geosoft_resources  LOCAL
gxapi.FILE_FILTER_VT = 107
Shell VT Files     \ `*`\ .vt        LOCAL
gxapi.FILE_FILTER_INT = 108
Shell INT Files     \ `*`\ .int      LOCAL
gxapi.FILE_FILTER_SGT = 109
Shell SGT Files     \ `*`\ .sgt      LOCAL
gxapi.FILE_FILTER_IMGVIEW = 110
Image Viewer Files  \ `*`\ .imgview  LOCAL
gxapi.FILE_FILTER_ZIP = 111
Zip Files  \ `*`\ .zip  LOCAL
gxapi.FILE_FILTER_GPS_TABLE = 112
GPS Table \ `*`\ .tbl GEOSOFT
gxapi.FILE_FILTER_VULCAN_TRIANGULATION = 113
Maptek Vulcan trianguilation file   \ `*`\ .tbl     LOCAL
gxapi.FILE_FILTER_VULCAN_BLOCK_MODEL = 114
Maptek Vulcan block model file       \ `*`\ .bmf                        LOCAL
gxapi.FILE_FILTER_PRJVIEW = 115
Layout Files  \ `*`\ .prjview  LOCAL
gxapi.FILE_FILTER_LEAPFROG_MODEL = 116
Leapfrog model files  \ `*`\ .lfm  LOCAL
gxapi.FILE_FILTER_IOGAS = 117
Reflex ioGAS files  \ `*`\ .gas  LOCAL
gxapi.FILE_FILTER_ASEG_ESF = 118
ASEG ESF File  \ `*`\ .esf  LOCAL
gxapi.FILE_FILTER_LACOSTE_DAT = 119
Micro-g LaCoste MGS-6 gravity files  \ `*`\ .DAT  LOCAL
gxapi.FILE_FILTER_VAR = 120
Geosoft variogram file  \ `*`\ .var  LOCAL
gxapi.FILE_FILTER_P190 = 121
UKOOA data exchange file  \ `*`\ .p190  LOCAL
gxapi.FILE_FILTER_UBC_OBS_DAT = 122
UBC observation files \ `*`\ .dat            LOCAL
gxapi.FILE_FILTER_UBC_LOC = 123
UBC location files \ `*`\ .loc               LOCAL

FILE_FORM constants

File Form Defines
gxapi.FILE_FORM_OPEN = 0
Open a file
gxapi.FILE_FORM_SAVE = 1
Save a file

GS_DIRECTORY constants

Geosoft predefined directory
gxapi.GS_DIRECTORY_NONE = 0
gxapi.GS_DIRECTORY_GEOSOFT = 1
gxapi.GS_DIRECTORY_BIN = 2
gxapi.GS_DIRECTORY_GER = 3
gxapi.GS_DIRECTORY_OMN = 4
gxapi.GS_DIRECTORY_TBL = 5
gxapi.GS_DIRECTORY_FONTS = 6
gxapi.GS_DIRECTORY_GX = 7
gxapi.GS_DIRECTORY_GS = 8
gxapi.GS_DIRECTORY_APPS = 9
gxapi.GS_DIRECTORY_ETC = 10
gxapi.GS_DIRECTORY_HLP = 11
gxapi.GS_DIRECTORY_GXDEV = 12
gxapi.GS_DIRECTORY_COMPONENT = 13
gxapi.GS_DIRECTORY_CSV = 14
gxapi.GS_DIRECTORY_LIC = 15
gxapi.GS_DIRECTORY_INI = 16
gxapi.GS_DIRECTORY_TEMP = 17
gxapi.GS_DIRECTORY_UETC = 18
gxapi.GS_DIRECTORY_UMAPTEMPLATE = 19
gxapi.GS_DIRECTORY_COMPONENT_SCRIPTS = 50
gxapi.GS_DIRECTORY_COMPONENT_HTML = 51
gxapi.GS_DIRECTORY_IMG = 52
gxapi.GS_DIRECTORY_BAR = 53
gxapi.GS_DIRECTORY_GXNET = 54
gxapi.GS_DIRECTORY_MAPTEMPLATE = 55

IMPCH_TYPE constants

Import Chem defines
gxapi.IMPCH_TYPE_DATA = 0
gxapi.IMPCH_TYPE_ASSAY = 1

WINDOW_STATE constants

Window State Options
gxapi.WINDOW_RESTORE = 0
gxapi.WINDOW_MINIMIZE = 1
gxapi.WINDOW_MAXIMIZE = 2

XTOOL_ALIGN constants

XTool docking alignment flags
gxapi.XTOOL_ALIGN_LEFT = 1
gxapi.XTOOL_ALIGN_TOP = 2
gxapi.XTOOL_ALIGN_RIGHT = 4
gxapi.XTOOL_ALIGN_BOTTOM = 8
gxapi.XTOOL_ALIGN_ANY = 15

XTOOL_DOCK constants

XTool default docking state
gxapi.XTOOL_DOCK_TOP = 1
gxapi.XTOOL_DOCK_LEFT = 2
gxapi.XTOOL_DOCK_RIGHT = 3
gxapi.XTOOL_DOCK_BOTTOM = 4
gxapi.XTOOL_DOCK_FLOAT = 5