Composite(library call)                             Composite(library call)




 NAME    [Toc]    [Back]
      Composite - The Composite widget class

 SYNOPSIS    [Toc]    [Back]
      #include <Xm/Xm.h>

 DESCRIPTION    [Toc]    [Back]
      Composite widgets are intended to be containers for other widgets and
      can have an arbitrary number of children. Their responsibilities
      (implemented either directly by the widget class or indirectly by
      Intrinsics functions) include:

         +  Overall management of children from creation to destruction.

         +  Destruction of descendants when the composite widget is
            destroyed.

         +  Physical arrangement (geometry management) of a displayable
            subset of managed children.

         +  Mapping and unmapping of a subset of the managed children.
            Instances of composite widgets need to specify the order in
            which their children are kept. For example, an application may
            want a set of command buttons in some logical order grouped by
            function, and it may want buttons that represent filenames to be
            kept in alphabetical order.

    Classes    [Toc]    [Back]
      Composite inherits behavior and resources from Core.

      The class pointer is compositeWidgetClass.

      The class name is Composite.

    New Resources    [Toc]    [Back]
      The following table defines a set of widget resources used by the
      programmer to specify data. The programmer can also set the resource
      values for the inherited classes to set attributes for this widget. To
      reference a resource by name or by class in a .Xdefaults file, remove
      the XmN or XmC prefix and use the remaining letters. To specify one of
      the defined values for a resource in a .Xdefaults file, remove the Xm
      prefix and use the remaining letters (in either lowercase or
      uppercase, but include any underscores between words).  The codes in
      the access column indicate if the given resource can be set at
      creation time (C), set by using XtSetValues (S), retrieved by using
      XtGetValues (G), or is not applicable (N/A).








                                    - 1 -       Formatted:  January 24, 2005






 Composite(library call)                             Composite(library call)




      ________________________________________________________________________
      |                        Composite Resource Set                         |
      |Name                Class               Type          Default   Access |
      |__________________|___________________|_____________|_________|________|
      |XmNchildren       | XmCReadOnly       | WidgetList  | NULL    | G      |
      |__________________|___________________|_____________|_________|________|
      |XmNinsertPosition | XmCInsertPosition | XtOrderProc | NULL    | CSG    |
      |__________________|___________________|_____________|_________|________|
      |XmNnumChildren    | XmCReadOnly       | Cardinal    | 0       | G      |
      |__________________|___________________|_____________|_________|________|
      |__________________|___________________|_____________|_________|________|

      XmNchildren    [Toc]    [Back]
                A read-only list of the children of the widget.

      XmNinsertPosition    [Toc]    [Back]
                Points to the XtOrderProc function described below.

      XmNnumChildren    [Toc]    [Back]
                A read-only resource specifying the length of the list of
                children in XmNchildren.

      The following procedure pointer in a composite widget instance is of
      type XtOrderProc:

      Cardinal (* XtOrderProc) (Widget w);

      w         Specifies the widget.

      Composite widgets that allow clients to order their children (usually
      homogeneous boxes) can call their widget instance's XmNinsertPosition
      procedure from the class's insert_child procedure to determine where a
      new child should go in its children array. Thus, a client of a
      composite class can apply different sorting criteria to widget
      instances of the class, passing in a different XmNinsertPosition
      procedure when it creates each composite widget instance.

      The return value of the XmNinsertPosition procedure indicates how many
      children should go before the widget. A value of 0 (zero) indicates
      that the widget should go before all other children; returning the
      value of XmNumChildren indicates that it should go after all other
      children.  By default, unless a subclass or an application provides an
      XmNinsertPosition procedure, each child is inserted at the end of the
      XmNchildren list.  The XmNinsertPosition procedure can be overridden
      by a specific composite widget's resource list or by the argument list
      provided when the composite widget is created.

    Inherited Resources    [Toc]    [Back]
      Composite inherits behavior and resources from the superclass
      described in the following table.  For a complete description of each
      resource, refer to the reference page for that superclass.



                                    - 2 -       Formatted:  January 24, 2005






 Composite(library call)                             Composite(library call)




      ________________________________________________________________________________________________________________
      |                                              Core Resource Set                                                |
      |Name                            Class                           Type             Default                Access |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNaccelerators               | XmCAccelerators               | XtAccelerators | dynamic              | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNancestorSensitive          | XmCSensitive                  | Boolean        | dynamic              | G      |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNbackground                 | XmCBackground                 | Pixel          | dynamic              | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNbackgroundPixmap           | XmCPixmap                     | Pixmap         | XmUNSPECIFIED_PIXMAP | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNborderColor                | XmCBorderColor                | Pixel          | XtDefaultForeground  | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNborderPixmap               | XmCPixmap                     | Pixmap         | XmUNSPECIFIED_PIXMAP | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNborderWidth                | XmCBorderWidth                | Dimension      | 1                    | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNcolormap                   | XmCColormap                   | Colormap       | dynamic              | CG     |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNdepth                      | XmCDepth                      | int            | dynamic              | CG     |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNdestroyCallback            | XmCCallback                   | XtCallbackList | NULL                 | C      |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNheight                     | XmCHeight                     | Dimension      | dynamic              | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNinitialResourcesPersistent | XmCInitialResourcesPersistent | Boolean        | True                 | C      |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNmappedWhenManaged          | XmCMappedWhenManaged          | Boolean        | True                 | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNscreen                     | XmCScreen                     | Screen *       | dynamic              | CG     |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNsensitive                  | XmCSensitive                  | Boolean        | True                 | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNtranslations               | XmCTranslations               | XtTranslations | dynamic              | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNwidth                      | XmCWidth                      | Dimension      | dynamic              | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNx                          | XmCPosition                   | Position       | 0                    | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |XmNy                          | XmCPosition                   | Position       | 0                    | CSG    |
      |______________________________|_______________________________|________________|______________________|________|
      |______________________________|_______________________________|________________|______________________|________|

    Translations    [Toc]    [Back]
      There are no translations for Composite.

 RELATED    [Toc]    [Back]
      Core(3).


                                    - 3 -       Formatted:  January 24, 2005