VkAlignmentGroup(3x)

NAME
     VkAlignmentGroup - Support for aligning widgets by size or position

INHERITS FROM
     VkWidgetList

HEADER FILE
     #include <Vk/VkAlignmentGroup.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkAlignmentGroup(void);
           virtual void ~VkAlignmentGroup(void);


   Adding Items
           virtual void add(VkOptionMenu* menu);


   Aligning Items By Position
           void alignLeft(void);
           void alignRight(void);
           void alignTop(void);
           void alignBottom(void);


   Aligning Sizes
           void alignWidth(void);
           void alignHeight(void);
           void makeNormal(void);


   Controlling Spacing
           void distributeVertical(void);
           void distributeHorizontal(void);

   Access Functions
           Dimension width(void);
           Dimension height(void);
           Position x(void);
           Position y(void);


PROTECTED PROTOCOL SUMMARY
   Protected Data Members
           Dimension _maxWidth;
           Dimension _maxHeight;
           Position _x;
           Position _y;

CLASS DESCRIPTION
          The VkAlignmentGroup class provides support for aligning collections
          of widgets with each other in various ways. To use, create an
          instance of the VkAlignmentGroup class, add widgets or components
          using the add() member function inherited from VkWidgetGroup, and
          then call alignWidth(), alignHeight(), or similar functions as
          desired.



FUNCTION DESCRIPTIONS
   VkAlignmentGroup()
           VkAlignmentGroup(void);


          Initializes a VkAlignmentGroup object.

   ~VkAlignmentGroup()
           virtual void ~VkAlignmentGroup(void);


          Frees the storage associated with a VkAlignmentGroup object. Does
          not destroy the widgets or components contained by this object.

   add()
           virtual void add(VkOptionMenu* menu);
           virtual void add(Widget widget);
           virtual void add(VkComponent component);


          Adds widgets, components, or all the entries in a VkOptionMenu pane
          to the group of widgets. Also see VkWidgetList::add().

   alignLeft()
           void alignLeft(void);


          Reposition all widgets so that all left edges align with the left
          edge of the right-most position occupied by any widget in the group.

   alignRight()
           void alignRight(void);


          Reposition all widgets so that the right side of each widget is
          moved to align with the right edge of the right-most widget in the
          group.

   alignTop()
           void alignTop(void);
          Reposition all widgets so that the top of each widget aligns with
          the top edge of the bottom-most widget in the group.

   alignBottom()
           void alignBottom(void);


          Reposition all widgets so that the bottom of each widget aligns with
          the bottom-most edge of any widget in the group.

   alignWidth()
           void alignWidth(void);


          Change all widgets' widths to the width of the largest widget in the
          group.

   alignHeight()
           void alignHeight(void);


          Change all widgets' heights to the height of the largest widget in
          the group.

   distributeVertical()
           void distributeVertical(void);


          Reposition all widgets so that they are positioned evenly in the
          vertical direction, according to the spacing between widgets,
          between the position of the first and last widgets in the group.

   distributeHorizontal()
           void distributeHorizontal(void);


          Reposition all widgets so that they are positioned evenly in the
          horizontal direction, according to the spacing between widgets,
          between the position of the first and last widgets in the group.

   makeNormal()
           void makeNormal(void);


          Return all widgets to their desired widths and heights.

   width()
           Dimension width(void);

          Return the maximum width of all widgets in the group.  This function
          is valid only after a call to one of the alignment functions.

   height()
           Dimension height(void);


          Return the maximum height of all widgets in the group.  This
          function is valid only after a call to one of the alignment
          functions.

   x()
           Position x(void);


          Return the minimum x position of all widgets in the group. This
          function is valid only after a call to one of the alignment
          functions.

   y()
           Position y(void);


          Return the minimum y position of all widgets in the group.  This
          function is valid only after a call to one of the alignment
          functions.

INHERITED MEMBER FUNCTIONS
   Inherited from VkWidgetList
          widgetDestroyed(), remove(), removeFirst(), removeLast(), exists(),
          size(), operator[]()


CLASSES USED BY THIS CLASS
     VkMenu, VkWidgetList

SEE ALSO
     VkMenu, VkWidgetList
     ViewKit Programmer's Guide
     The X Window System, DEC Press, Bob Sheifler and Jim Gettys
     The X Window System Toolkit, DEC Press, Paul Asente and Ralph Swick
     The OSF/Motif Programmers Reference, Prentice Hall, OSF