2. External Client Widget Resource Settings

The external client widget is a subclass of the Motif widget XmPrimitive and thus inherits all its resources. In addition, the following new resources are defined:

‘deadShell (class DeadShell)’

A boolean resource indicating whether the last request to the ExternalShell widget that contains the frame corresponding to this widget timed out. If true, no further requests will be made (all requests will automatically fail) until a response to the last request is received. This resource should normally not be set by the user.

‘shellTimeout (class ShellTimeout)’

A value specifying how long (in milliseconds) the client should wait for a response when making a request to the corresponding ExternalShell widget. If this timeout is exceeded, the client will assume that the shell is dead and will fail the request and all subsequent requests until a response to the request is received. Default value is 5000, or 5 seconds.

The shell that contains the frame corresponding to an external client widget is of type ExternalShell, as opposed to standard frames, whose shell is of type TopLevelShell. The ExternalShell widget is a direct subclass of Shell and thus inherits its resources. In addition, the following new resources are defined:

‘window (class Window)’

The X window ID of the widget to use for this Emacs frame. This is normally set by the call to x-create-frame and should not be modified by the user.

‘deadClient (class DeadClient)’

A boolean resource indicating whether the last request to the corresponding ExternalClient widget timed out. If true, no further requests will be made (all requests will automatically fail) until a response to the last request is received. This resource should normally not be set by the user.

‘ClientTimeout (class ClientTimeout)’

A value specifying how long (in milliseconds) the shell should wait for a response when making a request to the corresponding ExternalClient widget. If this timeout is exceeded, the shell will assume that the client is dead and will fail the request and all subsequent requests until a response to the request is received. Default value is 5000, or 5 seconds.

Note that the requests that are made between the client and the shell are primarily for handling query-geometry and geometry-manager requests made by parent or child widgets.

This document was generated by Aidan Kehoe on December 27, 2016 using texi2html 1.82.