VkListSearch(3x)

NAME
     VkListSearch - A utility class for implementing incremental search in a
     list

HEADER FILE
     #include <Vk/VkListSearch.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkListSearch(Widget list, Widget text,
                        Boolean usingVkList = False);
           ~VkListSearch();


   Configuration
           void setData(caddr_t d);


           void setListSetPos(VkListSetPosProc p);


           void setListSetMiddlePos(VkListSetMiddlePosProc p);


           void setListIsViewablePos(VkListIsViewablePosProc p);


           void setListDeselectAllItems(VkListDeselectAllItemsProc p);


           void setListSelectPos(VkListSelectPosProc p);


CLASS DESCRIPTION
          VkListSearch is a utility class for implementing incremental search
          within a Motif scrolled list (XmScrolledList or SgScrolledList) or
          within a custom list-like widget.  It takes a Motif text widget and
          a Motif list, and transparently implements the search behavior.



FUNCTION DESCRIPTIONS
   VkListSearch()
           VkListSearch(Widget list, Widget text,
                        Boolean usingVkList = False);
           virtual void ~VkListSearch(void);


          VkListSearch activates the search behavior for the text widget and
          the list widget.  The usingVkList parameter should be set to True
          when using SgList instead of XmList.
          By default, the list manipulation routines will be automatically
          setup for XmList or SgList.  When using a different kind of list, it
          is necessary to specify routines for manipulating the list.  Use the
          typedefs VkListSetPosProc, VkListSetMiddlePosProc,
          VkListIsViewablePosProc, VkListDeselectAllItemsProc, and
          VkListSelectPosProc to create appropriate functions, and use the
          methods setListSetPos, setListSetMiddlePos, setListIsViewablePos,
          setListDeselectAllItems, and setListSelectPos to set them.


   setData()
           void setData(caddr_t d);


          This function sets the clientData sent to the list manipulator
          functions.  It is ignored when using XmList or SgList.

   setListSetPos()
           void setListSetPos(VkListSetPosProc p);


          This function sets the function used to set the top list position.
          The function should behave like XmListSetPos.

   setListSetMiddlePos()
           void setListSetMiddlePos(VkListSetMiddlePosProc p);


          This function sets the function used to set the middle list
          position.

   setListIsViewablePos()
           void setListIsViewablePos(VkListIsViewablePosProc p);


          This function sets the function used to see if a list position is
          visible.

   setListDeselectAllItems()
           void setListDeselectAllItems(VkListDeselectAllItemsProc p);


          This function sets the function used to deselect all items in the
          list.  The function should behave like XmListDeselectAllItems.

   setListSelectPos()
           void setListSelectPos(VkListSelectPosProc p);


          This function sets the function used to select a list item.  The
          function should behave like XmListSelectPos.
   Inherited from VkComponent
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources(), manage(), unmanage(),
          baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback


   Inherited from VkCallbackObject
          callCallbacks(), addCallback(), removeCallback(),
          removeAllCallbacks()


SEE ALSO
     VkComponent
     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