VkMsgComponent(3x)

NAME
     VkMsgComponent - Abstract base class for all ViewKit message components

INHERITS FROM
     VkComponent :  VkCallbackObject

HEADER FILE
     #include <Vk/VkMsgComponent.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkMsgComponent(const char* name);
           virtual void ~VkMsgComponent(void);


   Message Facility Access
           VkMsgClient* messageClient(void);

           void updatePatterns(void);

           VkMsgPattern addAction(char* name,
                                  VkMsgClientAction proc,
                                  void *client_data,
                                  VkMsgActionType type,
                                  Boolean deleteMessage = True);

           VkMsgPattern createAction(char* name,
                                     VkMsgClientAction proc,
                                     void *client_data,
                                     VkMsgActionType type,
                                     Boolean deleteMessage = True);

           void removeAction(VkMsgPattern pat);

           void addTranslation(char* name,
                               VkMsgClientAction proc,
                               void *client_data,
                               Boolean deleteMessage = True);

           void removeTranslation(char* name);

           VkMsgStatus registerPattern(VkMsgPattern pat);

           VkMsgStatus unregisterPattern(VkMsgPattern pat);

           VkMsgStatus destroyPattern(VkMsgPattern pat);

CLASS DESCRIPTION
          VkMsgComponent is a subclass of VkComponent which creates a
          VkMsgClient object.  Components which handle messages (e.g. an
          editor component that sends and receives its own messages) should be
          subclasses of VkMsgComponent.  There are convenience methods for
          accessing VkMsgClient methods.



DERIVING SUBCLASSES
          The same guidelines for deriving from VkComponent apply to
          VkMsgComponent subclasses.



FUNCTION DESCRIPTIONS
   VkMsgComponent()
           VkMsgComponent(const char* name);
           virtual void ~VkMsgComponent(void);


          Same as VkComponent constructor

   messageClient()
           VkMsgClient* messageClient(void);


          Returns a pointer to the VkMsgClient object for access to message
          facility functionality.  See the VkMsgClient man page for more
          details.

   Message Routines
           void updatePatterns(void);

           VkMsgPattern addAction(char* name,
                                  VkMsgClientAction proc,
                                  void *client_data,
                                  VkMsgActionType type,
                                  Boolean deleteMessage = True);

           VkMsgPattern createAction(char* name,
                                     VkMsgClientAction proc,
                                     void *client_data,
                                     VkMsgActionType type,
                                     Boolean deleteMessage = True);

           void removeAction(VkMsgPattern pat);

           void addTranslation(char* name,
                               VkMsgClientAction proc,
                               void *client_data,
                               Boolean deleteMessage = True);
           void removeTranslation(char* name);

           VkMsgStatus registerPattern(VkMsgPattern pat);

           VkMsgStatus unregisterPattern(VkMsgPattern pat);

           VkMsgStatus destroyPattern(VkMsgPattern pat);


          Convenience routines for accessing VkMsgClient methods.  See the
          VkMsgClient man page for more details.

INHERITED MEMBER FUNCTIONS
   Inherited from VkComponent
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources(), manage(), unmanage(),
          baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback


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


CLASSES USED BY THIS CLASS
     VkMsgClient, VkMsgService

SEE ALSO
     VkComponent, VkMsgClient, VkMsgComponent, VkMsgService
     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