GRC Resources and Dialogs

A FORM resource will have one or more field and button components. Field and list resource components will appear on the dialog box in the order that you specify them, meaning that you can control their vertical positioning. Buttons appear at the bottom of the dialog, and are positioned horizontally left to right in the order specified.

FORM Component Parameters
 

SetInfo_DGW(hDGW,_MYFORM_0,DGW_LABEL,"My new label");

SetInfo_DGW(hDGW,_MYFORM_0,DGW_EXT,"My new extension");

There are two types of FEDIT components: those that create lists of already existing files, and those that are to specify new files. The type is specified using the OLD or NEW validation string. If NEW is specified, and the file already exists, the validation ensures that the user is prompted to verify whether the file is to be overwritten:

FEDIT,,,40,"Create a New File" ,R,NEW,,,*.dat
FEDIT,,,40,"Symbol Font Name",R,OLD,symbols,~,*.gfn
FEDIT,,,30,"Grid name",R,OLD,,,*.grd

In the second example, files of type “.gfn” in the user’s Geosoft directory will be displayed, and the symbols.gfn file will be selected by default, if no previous font file has been selected in this field.

In the third example, the presence of the “*.grd” alerts the resource compiler to the fact that grid files are requested, and the special grid file browser is invoked when the “...” browse button is selected beside this field. This grid browser automatically appends to the grid name the file decorations specific to the chosen grid type required to correctly interpret the grid.

EDIT

The EDIT components may be used in four basic ways: to handle strings, integers and real values, and to display a text label in a shaded window as a read-only field: 

EDIT ,,,30,"A Real value",,REAL
EDIT ,,,30,"An Int value",R,INT,10
EDIT ,,,30,"A String value",R
EDIT ,,,30,"Channel Name",N

In the first example, no input is required, but if it is, it must be a valid floating-point number. In the second example, an integer value is required, and 10 will be offered as default if no value is passed into the GX for this field. The third example requires the user to enter any string value. The fourth example is for printing out a channel name (for example); the user cannot change this value; the programmer determines it in the source code.

CEDIT

The CEDIT components are used to specify colours for coloured entities such as symbols, symbol fills, and lines. In the dialog, the edit window will be painted with the currently selected colour, and when the user clicks on the window the colour selection tool comes up so the user can select a different colour. The following are examples of the use of the CEDIT component: 

CEDIT ,,,30,"Line colour","K"
CEDIT ,,,30,"Line colour #2","R128"
CEDIT ,,,30,"Line colour"

The last (optional) field is the default colour string. Colour strings take the form “R#G#B#, where # is a value from 0 to 255, giving the intensity of the Red, Green or Blue colour. Black can be expressed in a number of ways, including “K”, “R0” or “R0G0B0”. (Colours not included are assumed to be at zero intensity.)  Letters given without numeric qualifiers are assumed to be at full intensity; for instance white can be written as “R255G255B255” or “RGB”.The default colour (third example above) is black “K”. In addition, you can use “N” (None) to indicate no colour, which is the same as transparent –for instance for fill colours in symbols – as well as “C” (Cyan), “Y” (Yellow), and “M” (Magenta).

LEDIT

The LEDIT component is a drop-down box containing a group of selectable parameters, such as channel names. It is used to allow the user to select an option from a predefined list, specified in a LIST resource. When you select an item, it replaces any existing text in the field. If the validation parameter of FORCE is specified  then only list items can be selected. otherwise the user can enter a new value.

The contents of the list are defined as  the list resource in the Resource file, or they can be defined at run time using the GetList_DGW method to the get the LIST object (see example below).

LEDIT,,,20,"Plot sizes?",R,FORCE,"Yes",YesNo
LEDIT,,,20,"Sizes",R,FORCE,"Large",SIZE 
LEDIT,,,20,"Channel",,FORCE,,CHAN

// The contents of this list will be provided in code.
RESOURCE,LIST,CHAN

RESOURCE,LIST,YesNo
ITEM, Yes,1
ITEM, No,0

RESOURCE,LIST,SIZE
ITEM, Small
ITEM, Medium
ITEM, Large

In the following GXC code example a LIST resource is filled with a sorted list of channels. If you omit the Sort_LST command the channels will be listed in the order they were created. In this case, the “_MYFORM_3” parameter indicates that the LEDIT component referenced is the fourth component (because indexing begins at 0) in the FORM resource whose resource_name is “MYFORM”. 

// --- Set up lists ---
List = GetList_DGW(hDGW,_MYFORM_3);   // retrieve list from dialog 
SymbLST_DB(Data,List,DB_SYMB_CHAN);   // fill the list from the database 
Sort_LST(List,0,0);                   // sort the list alphabetically  

BUTTONS

There are 2 types of buttons which can be included on your form.  The EBUT component is used to create a clickable button with a caption, while the HBUT component is used to link a HELP resource to the form. The presence of a HELP resource is indicated by a clickable question mark button on the top right of the dialog and will also be activated if the user presses F1.

EBUT,&OK,0
EBUT,&Cancel,1,CANCEL
HBUT,&Help,help

// In this example from BASEMAP2.GRC, a wizard-type dialog is simulated by using <Back and Next> buttons
EBUT,<&Back,0
EBUT,&Next>~,1
EBUT,&Cancel,-1,cancel
HBUT,&Help,maphelp

Different  return results can be used within a switch statement for more complicated program flow as shown in the following excerpt from DELLINES.GXC.

// --- Are we running interactively ? ---
if (iInteractive_SYS()) {   
	i = 0;
	while (i != 99) switch (i) {
		case 0:	// --- delete option ---
			Diag = Create_DGW("DELLINES0");
			SetInfoSYS_DGW(Diag,_DELLINES0_0,DGW_LISTALIAS,"DELLINES","OPTION");
			i = iRunDialogue_DGW(Diag);
			if (i == -1) Cancel_SYS();
			GetInfoSYS_DGW(Diag,_DELLINES0_0,DGW_LISTALIAS,"DELLINES","OPTION");
			Destroy_DGW(Diag);
			iOpt = iGetInt_SYS("DELLINES","OPTION");
			if (iOpt == 1) {
				if (iDisplayQuestion_SYS(_("Delete all selected lines/groups."),_("Confirm that you want to delete ALL selected lines and groups.")))
					i = 99;
				else
					i = 0;
			} else if (iOpt == 0)
				i = 99;
			else if (iOpt == 2)
				I= 1;
			else {
				DisplayMessage_SYS(_("Lost"),_("I'm lost"));
				i = 0;
			}
			break;
		case 1:// --- select a line to delete ---
			Diag = Create_DGW("DELLINES1");
			List = GetList_DGW(Diag,_DELLINES1_0);
			SymbLST_DB(Data,List,DB_SYMB_LINE);
			SetInfoSYS_DGW(Diag,_DELLINES1_0,DGW_TEXT,"DELLINES","LINE");
			i = iRunDialogue_DGW(Diag);
			if (i == -1) Cancel_SYS();
			GetInfoSYS_DGW(Diag,_DELLINES1_0,DGW_TEXT,"DELLINES","LINE");
			Destroy_DGW(Diag);
			break;
	}
}