Seth Woolley's Man Viewer

Composite(3) - Composite - The Composite widget class .iX Composite .iX widget class Composite - man 3 Composite

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Composite(library call)                                Composite(library call)



NAME
       Composite -- The Composite widget class

SYNOPSIS
       #include <Xm/Xm.h>

DESCRIPTION
       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 sub-
             set(7,n,1 builtins) of managed children.

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

   Classes
       Composite inherits behavior and resources from Core.

       The class pointer is compositeWidgetClass.

       The class name is Composite.

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


       +-----------------------------------------------------------------------+
       |                  |     Composite Reso|urce Set      |         |        |
       |Name              | Class             | Type        | Default | Access |
       +------------------+-------------------+-------------+---------+--------+
       |XmNchildren       | XmCReadOnly       | WidgetList  | NULL    | G      |
       +------------------+-------------------+-------------+---------+--------+
       |XmNinsertPosition | XmCInsertPosition | XtOrderProc | NULL    | CSG    |
       +------------------+-------------------+-------------+---------+--------+
       |XmNnumChildren    | XmCReadOnly       | Cardinal    | 0       | G      |
       +------------------+-------------------+-------------+---------+--------+
       +------------------+-------------------+-------------+---------+--------+
       XmNchildren
                 A read-only list of the children of the widget.

       XmNinsertPosition
                 Points to the XtOrderProc function described below.

       XmNnumChildren
                 A  read-only  resource  specifying  the length of the list of
                 children in(1,8) XmNchildren.

       The following procedure pointer in(1,8) 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(1,8) its children array. Thus, a client of a  compos-
       ite  class  can apply different sorting criteria to widget instances of
       the class, passing in(1,8) 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
       Composite inherits behavior and resources from the superclass described
       in(1,8) the following table.  For a complete description of  each  resource,
       refer to the reference page for that superclass.


       +---------------------------------------------------------------------------------------------------------------+
       |                              |               Core Resource Se|t                |                      |        |
       |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
       There are no translations for Composite.

RELATED
       Core(3).



                                                       Composite(library call)

References for this manual (incoming links)