VkMsgWindow(3x)

NAME
     VkMsgWindow - Base class for all top-level messaging windows with menus

INHERITS FROM
     VkWindow : VkSimpleWindow : VkComponent : VkCallabckObject

HEADER FILE
     #include <Vk/VkMsgWindow.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkMsgWindow(const char* name);

           virtual void ~VkMsgWindow(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
     VkMsgWindow is a subclass of VkWindow which creates a VkMsgClient object.
     Windows which handle messages (e.g. top-level application windows) should
     be subclasses of VkMsgWindow.  There are convenience methods for
     accessing VkMsgClient methods.  VkMsgWindow also provides support for
     raise and iconify operations.


DERIVING SUBCLASSES
     The same guidelines for deriving from VkWindow apply to VkMsgWindow
     subclasses.


FUNCTION DESCRIPTIONS
   VkMsgWindow()
           VkMsgWindow(const char* name);

           virtual void ~VkMsgWindow(void);


          Same as VkWindow 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.

          Be sure to add your message actions with addAction before entering
          any Xt event loop.  Otherwise, messages may be received before the
          action is registered, and they will not be processed as expected.
          The Xt event loop is entered when you call VkApp::run, or when you
          post a ViewKit dialog and a short, secondary event loop is entered.

INHERITED MEMBER FUNCTIONS
   Inherited from VkWindow
          className(),  setUpInterface(),  VkWindow(),  ~VkWindow(),
          setMenuBar(),  setMenuBar(), addMenuPane(),  addMenuPane(),
          addRadioMenuPane(),  addRadioMenuPane(),  menu(),


   Inherited from VkSimpleWindow
          afterRealizeHook(), show(), hide(), stateChanged(),
          handleWmDeleteMessage(), handleRawEvent(), addView(), removeView(),
          open(), raise(), lower(), iconize(), iconify(), getTitle(),
          setTitle(), setIconName(), setClassHint(), iconic(), visible(),
          mainWindowWidget(), viewWidget(), _iconState, _visibleState,
          _stackingState, _mainWindowWidget,


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


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


CLASSES USED BY THIS CLASS
     VkMsgClient, VkMsgService

SEE ALSO
     VkWindow, VkSimpleWindow, VkComponent, VkMsgClient, 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