GeoDict User Guide 2025

Share This Topic
GeoDict Software
Forum
Support
Math2Market

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Share This Topic
Save Permalink URL

Navigation: GeoDict 2025 - User Guide > Automation > GeoPy Scripting > Advanced Scripting > GeoDict API

Scroll

Dialog Class

Create your own customized dialog for variable input or messages.

gd.makeDialog

Create an input dialog object to query the user for parameters. There is a large variety of possible input fields.

Input:

key name, string
- This is used to store dialog settings in the settings map. Use a unique key for each dialog unless you are re-using the same dialog and want their settings to affect each other.
title, string (optional)
- The title is shown as the window title of the dialog. If no title is given, geodict2025 is shown.

Sub functions:

Note-Info

Note! In the examples for the input parameters often the notation "parameter name = parameter value" is used. This is not mandatory, but using this notation, the order and the number of optional arguments used does not matter anymore. This is very useful, if you only want to enter some of the optional parameters. Additionally it increases readability, highlighting which value belongs to which key. This can sometimes also be useful for obligatory arguments.

.addBoolInput

Add a check box to your dialog. The value is True, when the checkbox is enabled, otherwise False

Input:

key, string
description, string
init, bool (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addBoolInput("myBooleanParameter",

"This is a checkbox", init=True,

tooltip="Check this box or not.")

# create a check box,

# with key, description,

# default value and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addIntegerInput

Add an integer input to your dialog. Here, integer numbers can be entered in the corresponding field.

Input:

key, string
description, string
min, integer (optional)
max, integer (optional)
init, integer (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addIntegerInput("myIntegerParameter",

"This is an integer input", min=5, max=10,

init=6, tooltip="Enter an integer value.")

# create an input field

# for integer values with key,

# description, boundaries,

# default value and tooltip

dlg.addIntegerInput("myNewIntegerParameter",

"This is an parameter without limits",

init=42, tooltip="Enter some value here.")

# create an input field

# for integer values with key,

# description, default value

# and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

AUTOM-API-dialog_integer

.addUintegerInput

Add an uinteger input field to your dialog. Here, the value can also be changed by clicking the arrows on the right.

Input:

key, string
description, string
min, integer (optional)
max, integer (optional)
init, integer (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addUintegerInput("MyUintInput",

"This is an uinteger input",

min = -5, max = 5, init=0,

tooltip="Choose an integer parameter")

# create an input field

# for uinteger values with key,

# description, boundaries,

# default value and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addFloatInput

Add an floating point number input field. Here, floating point numbers can be entered.

Input:

key, string
description, string
min, float (optional)
max, float (optional)
init, float (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addFloatInput("myFloatParameter",

"This is a float input",

min = -3.5, max = 5.2, init=2.1,

tooltip="Enter a floating value.")

# create an input field

# for float values with key,

# description, boundaries,

# default value and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addTextInput

Add an text input field to your dialog. Here, text can be entered and will be considered as string.

Input:

key, string
description, string
init, string (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addTextInput("myStringParameter",

"This is a free form text input box",

init="This is a String",

tooltip="Enter text.")

# create an input field

# for text with key,

# description, default value

# and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addFileInput

Add a file input field. The input box comes with a Browse button to browse for the file. The value is considered as string.

Input:

key, string
description, string
file type, string (optional)
init, string (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addFileInput("myFileSelection",

"Browse for a file", "gdt",

init="File.gdt",

tooltip="Browse for a gdt file.")

# create an input field for

# gdt files with key,

# description, default value

# and tooltip

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addFolderInput

Add a folder input field. The input box comes with a Browse button to browse for the folder. The value is considered as string.

Input:

key, string
description, string
init, string (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addFolderInput("MyFolderInput",

"Browse for a folder")

# create an input field for

# folder paths with key,

# and description

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addComboInput

Add a combo box to your dialog. The value choice is given as list of strings. Within the script, the returned value is the index of the selected list item.

Input:

key, string
description, string
selection, list of strings
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addComboInput("myComboBox",

"Select an item from the list",

["1st item", "2nd item", "3rd item"])

# create a pull-down menu

# with the given values for

# selection.

# Key and description are given.

# The returned value is the

# index of the selected item,

# e.g. 0 for the first item,

# 1 for the second etc.

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addComboInputString

Add a combo box to your dialog. The value choice is given as list of strings. Within the script, the returned value is the string of the selected list item.

Input:

key, string
description, string
selection, list of strings
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addComboInputString("ComboString",

"Select another item",

["1st item", "2nd item", "3rd item"])

# create a pull-down menu

# with the given values for

# selection. Key and description

# are given.

# The returned value is

# the string of the

# selected item

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addMaterialInput

Add a material input box to your dialog. A material can be chosen from the GeoDict material database.

Input:

key, string
description, string

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addMaterialInput("MyMaterialInput",

"Choose a material")

# create an input button for

# browsing the material data

# base. Key and description are given.

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addTableInput

Add table input to your dialog. A table with multiple rows and the defined number of columns is given.

Input:

key, string
description, string
types, list of strings
columnHeaders, list of strings
init, list of given types (optional)
tooltip, string (optional)

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addTableInput("MyTableInput",

"This is a table input.",

types = "int,float",

columnHeaders=["left","right"],

init=[[1,2.0],[3,4.0]])

# create a table with two columns,

# one for integer input

# and one for float.

# Two default rows are given.,

# additionally to the mandatory

# key, description, types and headers

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.addText

Add free-form text to your dialog in the given font size and in bold (True) or not bold (False).

Input:

key, string
description, string
font size, integer (optional, default is 8))
setBold, bool (optional, default is false)

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addText("Any arbitrary text",

20, True)

# add bold text to the

# dialog with font size 20

dlg.addText("More arbitrary text",

10, False)

# add text to the dialog

# with font size 10

# and not bold

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.beginGroup

Fields can be grouped within a box. Add input values or free text between the beginGroup and endGroup lines.

Input:

group name, string

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addText("Text outside the box.",

20, True)

# add bold text to the

# dialog with font size 20

dlg.addText("More arbitrary text",

10, False)

# add text to the dialog

# with font size 10

# and not bold

dlg.beginGroup("My Group")

# start a group

# to add a box

dlg.addText("Text in the group box")

# add any content inside

# box, here we added

# only some text

dlg.endGroup()

# end the group

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

.endGroup

Fields can be grouped within a box. Add input values or free text between the beginGroup and endGroup lines.

Input: None

Example: see beginGroup() above.

.addImage

Add images to the dialog box. Before you can add them, they must be transformed to a 3D numpy array, which can for example be done using the Python packages PIL and numpy.

Input:

image, 3D numpy array

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")	# create a dialog object # with a key and a title
from PIL import Image	# import Python package # to edit images
import numpy as np	# import Python package # to use arrays
image = Image.open("image.png")	# open desired image, if image # is not contained # in project folder, # complete file path # must be given
w,h = image.size	# get size of image
image = image.resize((500,round(500*h/w)))	# resize image to fit in the dialog, # without changing aspect ratio
I = np.asarray(image)	# transform image to a # 3D numpy array
dlg.addImage(I)	# add image to the dialog
result = dlg.run()	# open the dialog with all the # settings assigned to the dialog # variable, here dlg

.run

Execute the dialog.

Input: None

Example: see any other function above.

.saveSettings

Save the dialog settings as a *.gps file (GeoDict parameter settings) after calling run().

Input:

file path, string

Example: see below in the examples for interaction with dialog object.

Input explanations for the sub functions:

key
- Define a name for this argument to call the entered value within the python script
description
- this description is shown in the generated dialog box
file type
- define the file type for the input file. If set, only this file type can be found when browsing for the file.
init
- the init argument gives the initial value for the field (the built-in default)
tooltip
- the tooltip specifies a description string that is shown when the user hovers the mouse over the input field.

min/max
- min/max arguments restrict the range of input
font size
- set font size of text
setBold
- text is displayed in bold (True) or not (False). By default it is not bold.

All examples in one dialog

Example:

dlg = gd.makeDialog("MyDialog", "Dialog Example")

# create a dialog object

# with a key and a title

dlg.addBoolInput("myBooleanParameter",

"This is a checkbox", init=True,

tooltip="Check this box or not.")

# create a check box,

# with key, description,

# default value and tooltip

dlg.addIntegerInput("myIntegerParameter",

"This is an integer input", min=5, max=10,

init=6, tooltip="Enter an integer value.")

# create an input field

# for integer values with key,

# description, boundaries,

# default value and tooltip

dlg.addUintegerInput("MyUintInput",

"This is an uinteger input",

min = -5, max = 5, init=0,

tooltip="Choose an integer parameter")

# create an input field

# for uinteger values with key,

# description, boundaries,

# default value and tooltip

dlg.addIntegerInput("myNewIntegerParameter",

"This is an parameter without limits",

init=42, tooltip="Enter some value here.")

# create an input field

# for integer values with key,

# description, default value

# and tooltip

dlg.addFloatInput("myFloatParameter",

"This is a float input",

min = -3.5, max = 5.2, init=2.1,

tooltip="Enter a floating value.")

# create an input field

# for float values with key,

# description, boundaries,

# default value and tooltip

dlg.addTextInput("myStringParameter",

"This is a free form text input box",

init="This is a String",

tooltip="Enter text.")

# create an input field

# for text with key,

# description, default value

# and tooltip

dlg.addFileInput("myFileSelection",

"Browse for a file", "gdt",

init="File.gdt",

tooltip="Browse for a gdt file.")

# create an input field for

# gdt files with key,

# description, default value

# and tooltip

dlg.addFolderInput("MyFolderInput",

"Browse for a folder")

# create an input field for

# folder paths with key,

# and description

dlg.addComboInput("myComboBox",

"Select an item from the list",

["1st item", "2nd item", "3rd item"])

# create a pull-down menu

# with the given values for

# selection.

# Key and description are given.

# The returned value is the

# index of the selected item,

# e.g. 0 for the first item,

# 1 for the second etc.

dlg.addComboInputString("ComboString",

"Select another item",

["1st item", "2nd item", "3rd item"])

# create a pull-down menu

# with the given values for

# selection. Key and description

# are given.

# The returned value is

# the string of the

# selected item

dlg.addMaterialInput("MyMaterialInput",

"Choose a material")

# create an input button for

# browsing the material data

# base. Key and description are given.

dlg.addTableInput("MyTableInput",

"This is a table input.",

types = "int,float",

columnHeaders=["left","right"],

init=[[1,2.0],[3,4.0]])

# create a table with two columns,

# one for integer input

# and one for float.

# Two default rows are given.,

# additionally to the mandatory

# key, description, types and headers

dlg.addText("Any arbitrary text",

20, True)

# add bold text to the

# dialog with font size 20

dlg.addText("More arbitrary text",

10, False)

# add text to the dialog

# with font size 10

# and not bold

dlg.beginGroup("My Group")

# start a group

# to add a box

dlg.addText("Text in a group box")

# add any content inside

# box, here we added

# only some text

dlg.endGroup()

# end the group

from PIL import Image

# import Python package

# to edit images

import numpy as np

# import Python package

# to use arrays

image = Image.open("image.png")

# open desired image, if image

# is not contained

# in project folder,

# complete file path

# must be given

w,h = image.size

# get size of image

image = image.resize((100,round(100*h/w)))

# resize image to fit in the dialog,

# without changing aspect ratio

I = np.asarray(image)

# transform image to a

# 3D numpy array

dlg.addImage(I)

# add image to the dialog

result = dlg.run()

# open the dialog with all the

# settings assigned to the dialog

# variable, here dlg

Examples for interaction with dialog object

If the user clicks Cancel, result will be None.

Otherwise, result will be a dictionary containing the entered values, e.g.

gd.msgBox("You have selected the file:"

+ result["myFileSelection"])

# access a dialog value

dlg.saveSettings("MyFirstCustomDialogSettings.gps")

# save the entered settings

# as *.gps file

# (GeoDict parameter settings)

Contents
Search

Please enable JavaScript to view this site.

GeoDict User Guide 2025

Dialog Class

gd.makeDialog

Sub functions: