() — SVR4 Issue2.2



Flattened Widget Utilities(3W)   UNIX System V   Flattened Widget Utilities(3W)


   NAME
      Flattened Widget Utilities: OlFlatCallAcceptFocus, OlFlatGetFocusItem,
      OlFlatGetItemIndex, OlFlatGetItemGeometry, OlFlatGetValues,
      OlFlatSetValues, OlVaFlatGetValues OlVaFlatSetValues - queries and
      manipulates flattened widget attributes

   SYNOPSIS
      There are several convenience routines for querying or manipulating
      flattened widget attributes.  All of these routines issue a warning if
      the widget id is not a subclass of a flattened widget.

      Boolean OlFlatCallAcceptFocus(widget, index, time)
           Widget       widget;    /* Flattened widget id */
           Cardinal     index;     /* Item's index        */
           Time         time;      /* time of request     */


      Cardinal OlFlatGetFocusItem(widget)
           Widget     widget;      /* Flattened widget id */


      Cardinal OlFlatGetItemIndex(widget, x, y)
           Widget       widget;    /* Flattened widget id       */
           Position     x;         /* x location within widget  */
           Position     y;         /* y location within widget  */

      void OlFlatGetItemGeometry(widget, index, x_ret, y_ret, w_ret, h_ret)
           Widget       widget;    /* Flattened widget id       */
           Cardinal     index;     /* Item's index              */
           Position *   x_ret;     /* returned x coordinate     */
           Position *   y_ret;     /* returned y coordinate     */
           Dimension    w_ret;     /* returned width            */
           Dimension *  h_ret;     /* returned height           */


   Getting and Setting Flattened Widget Item State
      void OlFlatGetValues(widget, index, args, num_args)
           Widget       widget;    /* Flattened widget id       */
           Cardinal     index;     /* Item's index              */
           ArgList      args;      /* attributes to query       */
           Cardinal     num_args;  /* number of args            */

      void OlFlatSetValues(widget, index, args, num_args)
           Widget       widget;    /* Flattened widget id       */
           Cardinal     index;     /* Item's index              */
           ArgList      args;      /* attributes to set         */
           Cardinal     num_args;  /* number of args            */

      void OlVaFlatGetValues(widget, index, ...)
           Widget       widget;    /* Flattened widget id       */
           Cardinal     index;     /* Item's index              */
           ...                     /* variable name/value pairs */


10/89                                                                    Page 1



Flattened Widget Utilities(3W)   UNIX System V   Flattened Widget Utilities(3W)


      void OlVaFlatSetValues(widget, index, ...)
           Widget       widget;    /* Flattened widget id       */
           Cardinal     index;     /* Item's index              */
           ...                     /* variable name/value pairs */


DESCRIPTION
   OlFlatCallAcceptFocus()
      If specified item is capable of accepting input focus, focus is assigned
      to the item and function returns TRUE; otherwise, FALSE is returned.

   BOlFlatGetFocusItem()
      Returns the item within the flattened widget which has focus.  OL_NO_ITEM
      is returned if no item within the widget has focus.

   OlFlatGetItemIndex()
      Returns the item that contains the given x and y coordinates.  OL_NO_ITEM
      is returned otherwise if no item contains the coordinate pair.

   OlFlatGetItemGeometry()
      Returns the location and width/height of an item with respect to its
      flattened widget container.  If the supplied item index is invalid, a
      warning is issued and the return values are set to zero.

   OlFlatGetValues()
      Queries attributes of an item.  This routine is very similar to
      XtGetValues.  Applications can query any attribute of an item even if the
      attribute was not specified in the XtNitemFields resource of the flat
      widget container.  Also see OlVaFlatGetValues().

   OlFlatSetValues()
      Sets attributes of an item.  This routine is very similar to XtSetValues.
      Applications can set values of item attributes only even if the attribute
      name was specified in the XtNitemFields resource of the flat widget
      container or if the item's attribute is always maintained (i.e.,
      implicitly) by the flat widget container regardless of the XtNitemFields
      entries.  For example, since the FlatExclusives Widget always maintains
      the value of an item's XtNset attribute even if XtNset was not in the
      XtNitemFields resource (see FlatExclusives(3W)).  Therefore, an
      application can set the value of XtNset even though XtNset was not
      specified explicitly in the XtNitemFields resource for the widget.
      XtNfont, on the otherhand, is not implicitly maintained by the
      FlatExclusives Widget, so an application must specify XtNfont in the
      XtNitemFields resource if that application wants to change the font value
      via OlFlatSetValues.  Also see OlVaFlatSetValues().

   OlVaFlatGetValues()
      Variable argument interface to OlFlatGetValues.  The variable length list
      of resource name/value pairs is terminated by a NULL resource name.





Page 2                                                                    10/89



Flattened Widget Utilities(3W)   UNIX System V   Flattened Widget Utilities(3W)


   OlVaFlatSetValues()
      Variable argument interface to OlFlatSetValues.  The variable length list
      of resource name/value pairs is terminated by a NULL resource name.



















































10/89                                                                    Page 3

Museum