  | 
		
DECwindows Motif for OpenVMS Guide to Non-C
Bindings
 
 
3.63 Visual Info Data Structure
Figure 3-63 illustrates the visual info data structure
(X$VISUAL_INFO).
 
Figure 3-63 Visual Info Data Structure
  
Table 3-65 describes the members of the window attributes data
structure. 
 
  Table 3-65 Window Attributes Data Structure Members
  
    | Member Name  | 
    Contents  | 
   
  
    | 
      X$L_WDAT_X
     | 
    
      Specifies the x-coordinate of the upper left outside corner of the
      window relative to its parent window.
     | 
   
  
    | 
      X$L_WDAT_Y
     | 
    
      Specifies the y-coordinate of the upper left outside corner of the
      window relative to its parent window.
     | 
   
  
    | 
      X$L_WDAT_WIDTH
     | 
    
      Specifies the width of the window, excluding the window border, in
      pixels.
     | 
   
  
    | 
      X$L_WDAT_HEIGHT
     | 
    
      Specifies the height of the window, excluding the window border, in
      pixels.
     | 
   
  
    | 
      X$L_WDAT_BORDER_WIDTH
     | 
    
      Specifies the width of the window border in pixels.
     | 
   
  
    | 
      X$L_WDAT_DEPTH
     | 
    
      Specifies the bits per pixel of the window.
     | 
   
  
    | 
      X$L_WDAT_VISUAL
     | 
    
      The VISUAL structure associated with the window. The VISUAL structure
      specifies how displays should treat color resources.
     | 
   
  
    | 
      X$L_WDAT_ROOT
     | 
    
      Identifies the screen with which the window is associated.
     | 
   
  
    | 
      X$L_WDAT_CLASS
     | 
    
      Specifies whether the window accepts input and output, or input only.
     | 
   
  
    | 
      X$L_WDAT_BIT_GRAVITY
     | 
    
      Specifies how pixels should be moved when the window is resized.
     | 
   
  
    | 
      X$L_WDAT_WIN_GRAVITY
     | 
    
      Specifies how the window should be repositioned when its parent window
      is resized.
     | 
   
  
    | 
      X$L_WDAT_BACKING_STORE
     | 
    
      Indicates whether the server should maintain a record of portions of a
      window that are obscured when the window is mapped. Xlib can set this
      member to one of the following constants:
      
        
          | 
            x$c_when_mapped
           | 
          
             
           | 
         
        
          | 
            x$c_always
           | 
          
             
           | 
         
        
          | 
            x$c_not_useful
           | 
          
             
           | 
         
       
     | 
   
  
    | 
      X$L_WDAT_BACKING_PLANES
     | 
    
      Indicates (with bits set to 1) which bit planes of the window hold
      dynamic data that must be preserved in backing stores and during save
      unders.
     | 
   
  
    | 
      X$L_WDAT_BACKING_PIXEL
     | 
    
      Defines what values to use in planes not specified by
      X$L_WDAT_BACKING_PLANES.
     | 
   
  
    | 
      X$L_WDAT_SAVE_UNDER
     | 
    
      Setting this member to true informs the server that the client would
      like the contents of the screen saved when the window obscures them.
      Saving the contents of obscured portions of the screen is not
      guaranteed.
     | 
   
  
    | 
      X$L_WDAT_COLORMAP
     | 
    
      Specifies the color map, if any, that best reflects the colors of the
      window. The color map must have the same visual type as the window. If
      it does not, an error occurs.
     | 
   
  
    | 
      X$L_WDAT_MAP_INSTALLED
     | 
    
      If set to true, indicates that the color map is currently installed and
      the window is being displayed in its correct colors.
     | 
   
  
    | 
      X$L_WDAT_MAP_STATE
     | 
    
      Indicates whether the window is mapped and viewable. Xlib can set this
      member to one of the following constants:
      
        
          | 
            x$c_is_unmapped
           | 
          
             
           | 
         
        
          | 
            x$c_is_unviewable
           | 
          
             
           | 
         
        
          | 
            x$c_is_viewable
           | 
          
             
           | 
         
       
     | 
   
  
    | 
      X$L_WDAT_ALL_EVENT_MASKS
     | 
    
      Indicates the set of events in which all applications have an interest.
      X$L_WDAT_ALL_EVENTS_MASK is the inclusive-OR of all event masks set for
      the window.
     | 
   
  
    | 
      X$L_WDAT_YOUR_EVENT_MASK
     | 
    
      Indicates the events about which the querying client is interested in
      receiving notice.
     | 
   
  
    | 
      X$L_WDAT_DO_NOT_PROPAGATE_MASK
     | 
    
      Defines which events should not be propagated to its ancestors when no
      application has the event type selected in the window.
     | 
   
  
    | 
      X$L_WDAT_OVERRIDE_REDIRECT
     | 
    
      Specifies whether requests to map and configure the window should
      override a request by another client to redirect those calls.
     | 
   
  
    | 
      X$L_WDAT_SCREEN
     | 
    
      Specifies the screen on which the window is mapped.
     | 
   
 
3.65 Window Changes Data Structure
Figure 3-65 illustrates the window changes data structure
(X$WINDOW_CHANGES).
 
Figure 3-65 Window Changes Data Structure
  
Table 3-67 describes the members of the WM hints data structure. 
 
  Table 3-67 WM Hints Data Structure Members
  
    | Member Name  | 
    Contents  | 
   
  
    | 
      X$L_HINT_FLAGS
     | 
    
      Specifies the members of the data structure that are defined.
     | 
   
  
    | 
      X$L_HINT_INPUT
     | 
    
      Indicates whether or not the client relies on the window manager for
      keyboard input.
     | 
   
  
    | 
      X$L_HINT_INITIAL_STATE
     | 
    
      Defines how the window should appear in its initial configuration.
      Possible initial states are as follows:
      
        
          | 
            x$c_withdrawn_state
           | 
          
             
           | 
         
        
          | 
            x$c_normal_state
           | 
          
             
           | 
         
        
          | 
            x$c_iconic_state
           | 
          
             
           | 
         
       
     | 
   
  
    | 
      X$L_HINT_ICON_PIXMAP
     | 
    
      Identifies the pixmap used to create the window icon.
     | 
   
  
    | 
      X$L_HINT_ICON_WINDOW
     | 
    
      Specifies the window to be used as an icon.
     | 
   
  
    | 
      X$L_HINT_ICON_X
     | 
    
      Specifies the initial x-coordinate of the icon position.
     | 
   
  
    | 
      X$L_HINT_ICON_Y
     | 
    
      Specifies the initial y-coordinate of the icon position.
     | 
   
  
    | 
      X$L_HINT_ICON_MASK
     | 
    
      Specifies the pixels of the icon pixmap used to create the icon.
     | 
   
  
    | 
      X$L_HINT_WINDOW_GROUP
     | 
    
      Specifies that a window belongs to a group of other windows.
     | 
   
 
3.67 Error Handling
Xlib routines can return the error codes described in Table 3-68.
For more information about error handling, see the X Window System
document.  
 
  Table 3-68 Xlib Error Codes
  
    | Error Code  | 
    Description  | 
   
  
    | 
      X$C_BAD_ACCESS
     | 
    
      Possible causes are as follows:
      
      
               
      - An attempt to grab a key/button combination that has already been
      grabbed by another client
      
 - An attempt to free a color map entry that was not allocated by the
      client
      
 - An attempt to store in a read-only or unallocated color map entry
      
 - An attempt to modify the access control list from other than the
      local host
      
 - An attempt to select an event type, which only one client can
      select at a time, that has already been selected
      
  
     | 
   
  
    | 
      X$C_BAD_ALLOC
     | 
    
      The server did not allocate the requested resource for any cause.
     | 
   
  
    | 
      X$C_BAD_ATOM
     | 
    
      The value specified in an atom argument does not name a defined atom.
     | 
   
  
    | 
      X$C_BAD_COLOR
     | 
    
      A value specified for a color map argument does not name a defined
      color map.
     | 
   
  
    | 
      X$C_BAD_CURSOR
     | 
    
      A value specified for a cursor argument does not name a defined cursor.
     | 
   
  
    | 
      X$C_BAD_DRAWABLE
     | 
    
      A value specified for a drawable argument does not name a defined
      window or pixmap.
     | 
   
  
    | 
      X$C_BAD_FONT
     | 
    
      A value specified for a font argument does not name a defined font (or,
      in some cases, graphics context).
     | 
   
  
    | 
      X$C_BAD_GC
     | 
    
      A value specified for a graphics context argument does not name a
      defined graphics context.
     | 
   
  
    | 
      X$C_BAD_ID_CHOICE
     | 
    
      The value you choose for a resource identifier that either is not
      included in the range assigned to the client, or is already in use.
      Normally cannot occur and should be considered a server or Xlib error.
     | 
   
  
    | 
      X$C_BAD_IMPLEMENTATION
     | 
    
      The server does not implement the entire request. Most likely caused by
      a server extension; a server that generates this error for a core
      protocol request is deficient.
     | 
   
  
    | 
      X$C_BAD_LENGTH
     | 
    
      Request is shorter or longer than required to minimally contain the
      arguments. Usually indicates an internal Xlib or server error. The
      length of a request exceeds the maximum length accepted by the server.
     | 
   
  
    | 
      X$C_BAD_MATCH
     | 
    
      Possible causes are as follows:
      
      - In a graphics request, the root and depth of the graphics context
      do not match those of the drawable.
      
 - An input-only window is used as a drawable.
      
 - One argument or pair of arguments has the correct type and range
      but fails to match in some other way required by the request.
      
 - An input-only window lacks this attribute.
      
  
     | 
   
  
    | 
      X$C_BAD_NAME
     | 
    
      The font or color that you specified does not exist.
     | 
   
  
    | 
      X$C_BAD_PIXMAP
     | 
    
      A value that you specified for a pixmap argument does not name a
      defined pixmap.
     | 
   
  
    | 
      X$C_BAD_REQUEST
     | 
    
      The major or minor op-code that you specified does not indicate a valid
      request. This is usually an Xlib or server error.
     | 
   
  
    | 
      X$C_BAD_VALUE
     | 
    
      Some numeric values fall outside the range of values accepted by the
      request. Unless a range is specified for an argument, the full range
      defined by the argument's type is accepted. Any argument defined as a
      set of alternatives can generate this error.
     | 
   
  
    | 
      X$C_BAD_WINDOW
     | 
    
      Value specified for a window argument does not name a defined window.
     | 
   
 
  
Part II OpenVMS DECwindows Intrinsics
Part II documents intrinsics routines and data structures and includes
the following chapters:
  
Chapter 4 Intrinsics Routines
This chapter documents the intrinsics routines. See Section 1.2 for
information about the format used to describe each routine.
  
XtAddActions
 
FORMAT
 XtAddActions
 (action, num_actions)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      action
     | 
    
      XtActionList
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      num_actions
     | 
    
      Cardinal
     | 
    
      read
     | 
    
      value
     | 
   
 
This routine, superseded by XtAppAddActions, is supported for backward
compatibility.
  
XtAddCallback
 
FORMAT
 XtAddCallback
 (w, callback_name, callback, client_data)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      w
     | 
    
      Widget
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      callback_name
     | 
    
      XtString
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      callback
     | 
    
      XtCallbackProc
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      client_data
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
 
 
XtAddCallbacks
 
FORMAT
 XtAddCallbacks
 (w, callback_name, callbacks)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      w
     | 
    
      Widget
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      callback_name
     | 
    
      XtString
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      callbacks
     | 
    
      XtCallbackRec (array)
     | 
    
      read
     | 
    
      reference
     | 
   
 
 
XtAddConverter
 
FORMAT
 XtAddConverter
 (from_type, to_type, converter, convert_args, num_args)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      from_type
     | 
    
      XtString
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      to_type
     | 
    
      XtString
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      converter
     | 
    
      XtConverter
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      convert_args
     | 
    
      XtConvertArgRec (array)
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      num_args
     | 
    
      Cardinal
     | 
    
      read
     | 
    
      value
     | 
   
 
This routine, superseded by XtSetTypeConverter and
XtAppSetTypeConverter, is supported for backward compatibility.
  
XtAddEventHandler
 
FORMAT
 XtAddEventHandler
 (w, event_mask, nonmaskable, proc, client_data)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      w
     | 
    
      Widget
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      event_mask
     | 
    
      EventMask
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      nonmaskable
     | 
    
      Boolean
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      proc
     | 
    
      XtEventHandler
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      client_data
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
 
 
XtAddExposureToRegion
 
FORMAT
 XtAddExposureToRegion
 (event, region)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      event
     | 
    
      Event
     | 
    
      read
     | 
    
      reference
     | 
   
  
    | 
      region
     | 
    
      Region
     | 
    
      read
     | 
    
      value
     | 
   
 
 
XtAddGrab
 
FORMAT
 XtAddGrab
 (w, exclusive, spring_loaded)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      w
     | 
    
      Widget
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      exclusive
     | 
    
      Boolean
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      spring_loaded
     | 
    
      Boolean
     | 
    
      read
     | 
    
      value
     | 
   
 
 
XtAddInput
 
FORMAT
 result XtAddInput
 (source, condition, proc, client_data)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      result
     | 
    
      XtInputId
     | 
    
      write
     | 
    
      value
     | 
   
  
    | 
      source
     | 
    
      LONGWORD
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      condition
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      proc
     | 
    
      XtInputCallbackProc
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      client_data
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
 
This routine, superseded by XtAppAddInput, is supported for backward
compatibility.
  
XtAddRawEventHandler
 
FORMAT
 XtAddRawEventHandler
 (w, event_mask, nonmaskable, proc, client_data)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      w
     | 
    
      Widget
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      event_mask
     | 
    
      EventMask
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      nonmaskable
     | 
    
      Boolean
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      proc
     | 
    
      XtEventHandler
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      client_data
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
 
 
XtAddTimeOut
 
FORMAT
 result XtAddTimeOut
 (interval, proc, client_data)
 
  
Argument Information
  
    | Argument  | 
    Type  | 
    Access  | 
    Mechanism  | 
   
  
    | 
      result
     | 
    
      XtIntervalId
     | 
    
      write
     | 
    
      value
     | 
   
  
    | 
      interval
     | 
    
      LONGWORD UNSIGNED
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      proc
     | 
    
      XtTimerCallbackProc
     | 
    
      read
     | 
    
      value
     | 
   
  
    | 
      client_data
     | 
    
      XtPointer
     | 
    
      read
     | 
    
      value
     | 
   
 
This routine, superseded by XtAppAddTimeOut, is supported for backward
compatibility.
 
  
  
		 |