2.242 .options[enum]

This attribute provides special settings for the respective object classes.

Definition

  • Data type

    boolean

  • Access

    get, set

  • changed event

    no

.options can be addressed with IDM enums. The enum values are as follows:

Object

option_index

Meaning

application

opt_cert_required

(since IDM version A.06.02.h)

Determines whether a certificate is required for an SSL connection.

 

opt_no_ssl_v2

(since IDM version A.06.02.h)

Specifies that version 2 of the SSL protocol is not used for an SSL connection.

 

opt_verify_peer

(since IDM version A.06.02.h)

Indicates whether for an SSL connection the opposite side should be verified.

canvas

opt_accept_child

(IDM for Motif only)

Canvas accepts child widgets (i.e. no focus).

 

opt_addevents

(IDM for Qt only)

Invokes the canvas function for all QEvents. In this case CCR_event is passed as reason. For instance, this enables responding to mouse moves.

false (default)
Usual invocation of the canvas function.
true
The canvas function is called for all QEvents, besides the usual invocations.

 

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_focus_frame

(IDM for Motif only)

No focus frame is drawn.

 

opt_graphicsview

(IDM for Qt only)

Determiines whether the Canvas is implemented by a QFrame or a QGraphicsView. Depending on the option value, there are differences in the DM_CanvasUserArgs.

false (default)
Implementation by a QFrame. During the expose event, it can be drawn directly into the QWidget.
true
Implementation by a QGraphicsView. No expose messages are passed to the canvas function. This mode, where the QGraphicsView is a container for a QGraphicsScene, is suitable, for example, to add objects to the QGraphicsScene, which it then draws independently.

 

opt_motif_shadow

(IDM for Motif only)

Canvas draws Motif shadow border.

checkbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_push_like

(IDM for Windows only)

The Checkbox looks like a Pushbutton.

 

opt_use_widget

(IDM for Motif only)

Does not use gadget, but always widget.

dialog

opt_et_margin

(IDM for Windows only)

This option controls whether the inner border of edittexts is drawn (default) or not.

edittext

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_html

(IDM for Qt only)

Controls whether the edittext renders HTML and displays contents formatted accordingly.

false (default)
No rendering of HTML and no formatting of contents.
true
HTML rendering with formatted display of contents.

 

opt_rtf

(IDM for Windows only)

Controls whether the edittext accepts Rich Text Format (RTF) and displays formatted texts.

false (default)
No processing of RTF and no formatted display.
true
RTF processing with formatted display of text.

filereq

fro_createprompt

(IDM for Windows only,
only in mode fr_load with .mustexist = true)

When selecting an existing file a dialog pops up for safeguarding the creation of a file.

 

fro_overwriteprompt

(IDM for Windows and IDM for Qt only,
only in mode fr_save)

When selecting an existing file a dialog pops up to confirm overwriting the file.

Note on the IDM for Qt

For the combination .mustexist = true with .options[opt_overwriteprompt] = true, no dialog will be displayed to confirm overwriting.

 

fro_relativepath

(IDM for Motif only,
since Motif version 2.1)

The pattern and the current path are displayed separately and the selected file is only shown as file name without directory.

groupbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_scroll_on_focus

(IDM for Motif only,
since IDM version A.05.02.i)

Controls the behavior with focusing and may improve accessibility through keyboard navigation (see chapter “Motif Option .options[opt_scroll_on_focus]”).

true (default)
The IDM tries to scroll the child object that shall receive the focus into the visible area.
false
The IDM does not try to scroll the child object that shall receive the focus into the visible area.

image

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_sim_insensitive

(IDM for Windows and IDM for Qt only,
IDM for Qt since IDM version A.06.02.g)

Controls if a picture for the insensitive state is generated.

false (default)
No picture is generated.
true
A faded picture is generated for the insensitive state.

layoutbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_scroll_on_focus

(IDM for Motif only,
since IDM version A.05.02.i)

Controls the behavior with focusing and may improve accessibility through keyboard navigation (see chapter “Motif Option .options[opt_scroll_on_focus]”).

true (default)
The IDM tries to scroll the child object that shall receive the focus into the visible area.
false
The IDM does not try to scroll the child object that shall receive the focus into the visible area.

listbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_quick_navigate

(IDM for Motif only)

Turns off the Quick Navigate Feature. This is a work-around for a Motif bug (since Motif 2.1) that causes beeps when the keyboard is pressed with enabled Quick Navigate Feature.

false
Quick Navigate Feature is deactivated.
true (default)
Quick Navigate Feature is activated.

 

opt_scroll_pixels

(IDM for Qt only,
since IDM version A.06.01.c)

Activates the Pixel Scroll Mode, which does not scroll by item but moves the next undisplayed area into the viewport. Thus, long entries exceeding the viewport can be scrolled stepwise. A page step equates the height of the viewport here, while a single step corresponds to the height of the first item (both measured in pixels).

false (default)
Pixel Scroll Mode is deactivated. Scrolling happens by item.
true
Pixel Scroll Mode is activated. Scrolling moves the next undisplayed area into the viewport.

menubox

opt_enable_tearoff

(IDM for Motif only)

Determines if the user can detach the menubox from the menubar and freely position it.

menuitem

opt_use_widget

(IDM for Motif only)

Does not use gadget, but always widget.

notebook

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

notepage

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_scroll_on_focus

(IDM for Motif only,
since IDM version A.05.02.i)

Controls the behavior with focusing and may improve accessibility through keyboard navigation (see chapter “Motif Option .options[opt_scroll_on_focus]”).

true (default)
The IDM tries to scroll the child object that shall receive the focus into the visible area.
false
The IDM does not try to scroll the child object that shall receive the focus into the visible area.

poptext

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_hscroll

(IDM for Windows only,
since IDM version A.06.01.h)

Activates a horizontal scrollbar in the poptext list.

false (default)
No horizontal scrollbar is activated.
true
A horizontal scrollbar is activated when the list contains items that cannot be displayed completely.

Note

The horizontal scrollbar appears within the display area and thus covers the lowest lines. A vertical scrollbar is then also displayed for this purpose. Since the operation of scrollbars in an open list is not easy for the user, this option should only be used if there is no other solution.

 

opt_mnemonic

Defines if Mnemonics are processed.

false
Mnemonics are ignored. A & is displayed as character.
true (default)
Mnemonics are processed. A & character is not shown, but interpreted as mark for a Mnemonic.

 

opt_old_select

Controls the triggering of select and activate events.

 

opt_quick_navigate

(IDM for Motif only)

Turns off the Quick Navigate Feature. This is a work-around for a Motif bug (since Motif 2.1) that causes beeps when the keyboard is pressed with enabled Quick Navigate Feature.

false
Quick Navigate Feature is deactivated.
true (default)
Quick Navigate Feature is activated.

Note

Quick Navigate only works with .style = poptext.

 

opt_sort

(IDM for Windows only)

Determines if the list is sorted. The sorting only affects the display, the order in the attribute .text [integer] and the indexes of the entries remain unchanged.

false (default)
No automatic sorting of the entries.
true
The list entries are sorted automatically. Supports the default behavior of Microsoft Windows which assumes a sorted list.

progressbar

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

pushbutton

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_use_widget

(IDM for Motif only)

Does not use gadget, but always widget.

radiobutton

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_push_like

(IDM for Windows only)

The Radiobutton looks like a Pushbutton.

 

opt_use_widget

(IDM for Motif only)

Does not use gadget, but always widget.

rectangle

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

scrollbar

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

setup

opt_balloon_toolhelp

(IDM for Windows only,
since IDM version A.05.01.c)

Defines the appearance of the toolhelp:

true (default)
The toolhelp is displayed as speech bubble.
false
The toolhelp is displayed as rectangle.

 

opt_yi_monitoring

If this option is set to false, monitor functions installed through YiRegisterUserEventMonitor() are not invoked. This is important for debugging, if there is a suspicion that a monitor function is implemented faultily. When monitor functions are disabled through the command line option or environment variable, they cannot be enabled by setting this option to true.

  opt_fontraster_compat

This option can be used to specify that the old calculation of the raster size should be used.

Attention: with version A.06.03.a the calculation of the raster size has changed. If no reference string is specified, M is used as reference string now. The option opt_fontraster_compat can be used to temporarily use the old calculation method.
Using this option the size calculation is partly based on the system font, which is not High DPI capable, so High DPI capable applications created with IDM for Windows 11 should not use this option.

See also “Options for raster calculation under Windows”

spinbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

splitbox

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

statictext

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_use_widget

(IDM for Motif only)

Does not use gadget, but always widget.

tablefield

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_new_align

(IDM for Motif and IDM for Windows)

Defines, which attributes determine the alignment of text.

false (default)
Text alignment is determined by the attributes .colalignment[integer] and .rowalignment[integer].
true
Text alignment is determined by the attributes .xalignment[index] and .yalignment[index].

 

opt_new_colwidth

(IDM for Motif only)

In older versions of the IDM for Motif (before A.03.10.f) for tables with .reffont defined, the column widths had been calculated incorrectly. For this there was a second patch in version A.03.10.f where the option opt_new_colwidth was introduced.

true (default)
Corrected column widths (calculated on the basis of grid units as with the layout of other objects).
false
Column widths are calculated according to the option opt_old_colwidth.

 

opt_old_colwidth

(IDM for Motif only)

In older versions of the IDM for Motif (before A.03.04.a) for tables with .reffont defined the columns had been too wide. For this there was a first patch in version A.03.04.a where the option opt_old_colwidth was introduced.

false (default)
Corrected, smaller column widths.
true
Column widths as before the correction.

Note

In version A.03.10.f the column widths were corrected again and the option opt_new_colwidth had been introduced. If opt_new_colwidth is set to true, this setting takes precedence over opt_old_colwidth.

 

opt_old_select

(IDM for Motif only,
since IDM version A.05.02.h)

With this option a selection- or action-oriented triggering of select events can be set. This enables consistent behavior of the Motif and Windows versions of the IDM.

true
select events are triggered when the activation state changes (selection-based). This corresponds to the behavior up to and including IDM version A.05.02.g.
false (default)
select events are triggered when a mouse button or the selection key is pressed (action-based). This corresponds to the behavior on Microsoft Windows. Consequently select events do not indicate a change of the activation state anymore. In order to respond to changes of the selection with .options[opt_old_select] = false, the activate and deactivate events can be used.

 

opt_xmborder_compat

(IDM for Motif only,
since IDM version A.06.01.a)

Compatibility option to draw the tablefield again with a 1 pixel wide border. Since IDM version A.06.01.a the default width for the border is 0.

This could also be achieved by setting .borderwidth = 1, but then a warning message would appear because .borderwidth will no longer be supported for the tablefield in the future.

toolbar

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

treeview

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_rightclick_selects

(IDM for Windows only)

Determines if entries can be selected with the right mouse button:

false (default)
No selection of entries with the right mouse button.
true
Entries can be selected with the right mouse button.

 

opt_scroll_on_focus

(IDM for Motif only,
since IDM version A.05.02.i)

Controls the behavior with focusing and may improve accessibility through keyboard navigation (see chapter “Motif Option .options[opt_scroll_on_focus]”).

true (default)
The IDM tries to scroll the child object that shall receive the focus into the visible area.
false
The IDM does not try to scroll the child object that shall receive the focus into the visible area.

Note

A treeview with .options[opt_scroll_on_focus] = false may become unreachable by keyboard navigation when the active entry is outside the visible area. However it remains focusable by mouse click.

window

opt_animated

(IDM for Qt only)

Toggles animations when toolbars are moved interactively.

false (default)
No animations when toolbars are moved.
true
Animated, interactive moving of toolbars. However, this leads to significantly more resize and move events.
 

opt_auto_close

(IDM for Windows and IDM for Qt only,
IDM for Qt since IDM version A.06.01.e)

This option prevents the window from closing automatically when the user selects the Close command from the system menu or the Close button in the title bar.

true (default)
Window closes automatically when Close is selected.
false
Window is not closed when selecting Close, but must be explicitly closed by the application. A behavior similar to the value true can be simulated by the rule on WINDOW close { this.visivle: = false; }.

 

opt_center_toolhelp

(IDM for Windows only)

Controls where the toolhelp is displayed:

false (default)
The toolhelp is displayed at the position of the mouse pointer.
true
The toolhelp is displayed centered below the object, provided there is enough space.

 

opt_help

(IDM for Windows only)

When this option is set, the help button with the question mark is displayed in the titlebar.

Note

The help button is not shown when all three other buttons (minimize, maximize, close) are displayed.

 

opt_nested_docks

(IDM for Qt only)

Enables Nested Docks, i.e. the arrangement of toolbars with .style = notepage in multi-row docks.

false (default)
Only single-row docks are possible.
true
Adjoined, multi-row docks are possible. However, this leads to a not so clear operation in interactions and shifts. The .dock_line attribute is observed. Nesting into the same dock is always relative to the previous toolbar in the same docking area.

Notes

  • The option only affects toolbars with .style = notepage.
  • If both .options[opt_nested_docks] = false and .options[opt_tabbed_docks] = false (default), the .dock_line attribute of toolbars with .style = notepage is ignored and all those toolbars are arranged side by side (horizontal) or one on top of another (vertical).

 

opt_scroll_on_focus

(IDM for Motif only,
since IDM version A.05.02.i)

Controls the behavior with focusing and may improve accessibility through keyboard navigation (see chapter “Motif Option .options[opt_scroll_on_focus]”).

true (default)
The IDM tries to scroll the child object that shall receive the focus into the visible area.
false
The IDM does not try to scroll the child object that shall receive the focus into the visible area.

 

opt_tabbed_docks

(IDM for Qt only)

Enables Tabbed Docks, i.e. the arrangement of toolbars with .style = notepage as tabs in one dock.

false (default)
Tabbed Docks are not possible.
true
Tabbed Docks sharing space are possible. toolbars with the same .dock_line are displayed as stacked pages with tabs. Tabbed Docks are similar to notebooks and notepages.

Notes

  • The option only affects toolbars with .style = notepage.
  • If both .options[opt_nested_docks] = false and .options[opt_tabbed_docks] = false (default), the .dock_line attribute of toolbars with .style = notepage is ignored and all those toolbars are arranged side by side (horizontal) or one on top of another (vertical).
 

opt_window_size

(IDM for Qt only)

Determines how sizes are interpreted for the window.

false (default)
Size specifications (.width, .height, minimum and maximum values) refer to the client area of the window.
true
Size specifications refer to the entire window, including menubar, toolbars, tabbed widgets and statusbar, but without decoration (titlebar, borders).

Example

With Motif 1.1, you cannot navigate over an object with keyboard navigation, if this object is a composite widget and if this widget has no children. A program abort is also likely. Therefore, the attribute .options has been made available.

Canvas1.options[opt_accept_child] := true;

See also

Object canvas

2.242.1 Motif Option .options[opt_scroll_on_focus]

Objects with virtual size (groupbox, layoutbox, notepage, window) and treeview have the option .options[opt_scroll_on_focus] since IDM version A.05.02.i. This option is used to define whether a child object is scrolled into the visible area when it gets focused.

Purpose of the Option

The option .options[opt_scroll_on_focus] primarily serves to improve the accessibility of objects via keyboard navigation and to enable that they are focused in certain constellations via keyboard or mouse click. This achieves a more consistent behavior between Motif and Windows applications.

However, the option – due to the differences between platforms in focus handling – cannot achieve full consistency, nor that objects can be focused by key command in all situations.

Relation Between Object Position, Visibility, Keyboard Navigation and Focusability on Motif

On Motif, only objects that are visible or that can be scrolled into the visible area may obtain focus. This is the typical behavior of Motif applications, unlike Microsoft Windows. Please note that a child object may be fully visible in a grouping object, but is still not accessible and reachable via keyboard, as the grouping object is not fully visible.

For compatibility reasons between the platforms, the ISA Dialog Manager also enables the positioning of child objects with negative positions for the x and y coordinates of the left upper corner in the non-visible areas on Motif. Motif does not actually allow this, so that the IDM must bypass check mechanisms. Consequentially, this usually rules out that the objects are reachable via keyboard navigation and that they can be focused.

Recommendations

  • The best way to ensure the accessibility of objects via keyboard navigation and their ability to be focused with keyboard and mouse is to always position them fully in the visible area and to avoid negative values for their x and y coordinates.
  • If this is not possible, you can attempt to improve key navigation and focusability with the help of .options[opt_scroll_on_focus].

2.242.2 Options for Grouping Objects under Windows

Attention

The options opt_wntsizebug_compat and opt_w2kprefsize_compat are deprecated. Since IDM version A.06.01.a they are not evaluated anymore.

It is strongly recommended to adapt dialogs that still rely on these options. Only if adaptation is not feasible, the command line option ‑IDMborder5_compat or the environment variable IDM_BORDER5_COMPAT may be used to bring back evaluation of opt_wntsizebug_compat and opt_w2kprefsize_compat (with the downside of losing support for the .borderstyle attribute).

With the change to Visual Styles on Windows XP and higher, several bugs in size calculation (causing a different behavior) were fixed. These bugs had existed since 3D objects had been supported on Windows.

Especially in dialogs which require pixel-perfect representation these problems had major impacts. Therefore the version of the IDM for Windows XP and higher have been made error compatible. For all grouping objects (groupbox, layoutbox, notebook, notepage, spinbox, splitbox, statusbar, toolbar and window) two additional options have been introduced:

.options[opt_wntsizebug_compat]

Default value: false

With the value false positions and sizes of all direct child objects are set in a correct manner. With the value true positions and sizes of all direct child objects are set in an error compatible mode. Since Windows versions dating back a long time there had been an error calculating positions and sizes of the objects edittext, groupbox, listbox, poptext and treeview. This error resulted in these objects being one pixel smaller than desired on each side.

This option is preset to the value false.

.options[opt_w2kprefsize_compat]

Default value: false

With the value true the preferred sizes of all direct child objects are calculated as if the application is running on Windows 2000. With the value false the preferred sizes of all direct child objects are calculated according to the Visual Styles in the Windows XP and higher versions of the IDM.

This option is preset to the value false. Therefore objects with no dimensions set appear in optimal dimensions with active Visual Styles.

If the appearance of a dialog is broken, this option can be turned on for the Default objects. Afterward the dialog can be adjusted successively.

2.242.3 Options for raster calculation under Windows

With IDM version A.06.03.a, the calculation of the raster width has been substantially changed. If no reference string is set, the raster width is now calculated from an internal reference string (M) to avoid excessive width growth due to excessively wide letters within a font.

For compatibility reasons, however, the opt_fontraster_compat option, the -IDMfontraster_compat startup option, or the IDM_FONTRASTER_COMPAT environment variable can temporarily reactivate the old raster width calculation (with the drawback that excessive width growth may occur again).
When using the opt_fontraster_compat, the size calculation is partly based on the system font, which is not High DPI capable, so High DPI capable applications created with IDM for Windows 11 should not use this option.