VkTextIO(3x)

NAME
     VkTextIO - Command-line interface text component

INHERITS FROM
     VkComponent : VkCallbackObject :

HEADER FILE
     #include <Vk/VkTextIO.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkTextIO(const char* name, Widget parent, const char* prompt = NULL);
           virtual void ~VkTextIO(void);


   Display Functions
           void clearHistory(void);
           virtual void outputString(char* str,
                                     Boolean skipInput = True);
           void outputChar(char ch, Boolean skipInput);


   Control Functions
           void disableRedisplay(void);
           void enableRedisplay(void);


   Access Functions
           Widget textWidget(void);
           Boolean activated(void);
           void activate(void);
           void deactivate(void);


CLASS DESCRIPTION
     The VkTextIO class provides a text widget that the user interacts with as
     if they were in a shell.  New entries appear at the end of the text
     widget, and return sends a line to the controlling application.



FUNCTION DESCRIPTIONS
   VkTextIO()
           VkTextIO(const char* name, Widget parent,
                    const char* prompt = NULL);
           virtual void ~VkTextIO(void);


          Creates a Motif scrolled text widget.  The first argument is the
          name of the text widget, the second is the parent, and the third is
          the prompt string displayed at the beginning of each line.
   clearHistory()
           void clearHistory(void);


          Since the text widget contents cannot be edited by the user except
          for the current line, the text contents grows without bound.  This
          method clears the old history of the text widget.

   outputString()
           virtual void outputString(char* str, Boolean skipInput);


          Sends a line of output to the text widget.

   outputChar()
           void outputChar(char ch, Boolean skipInput);


          Sends a character to the text widget.

   disableRedisplay()
           void disableRedisplay(void);


          Turns of XmText display.  This is useful when you have a lot of
          output to send in chunks, and don't want the overhead of text widget
          updating between each incremental output.

   enableRedisplay()
           void enableRedisplay(void);


          Turns on and update the XmText widget.  Call this method after
          you're done calling outputString() or outputChar().

   textWidget()
           Widget textWidget(void);


          Returns the actual text widget of the component.  The baseWidget()
          method returns the top-level scrolled window widget.

   activated()
          Boolean activated(void);


          Indicates whether the component is active (sensitive).

   activate()
          void activate(void);

          Makes the component sensitive.

   deactivate()
          void deactivate(void);


          Makes the component insensitive.

   textCallback
          static const const char* textCallback;


          A callback function for detecting a new input line in the command-
          line text widget or the user pressing CTRL-c.  The callData argument
          should be cast to a (VkTextIOCallback *).

INHERITED MEMBER FUNCTIONS
   Inherited from VkComponent
          className(),  installDestroyHandler(),  removeDestroyHandler(),
          widgetDestroyed(), afterRealizeHook(),  setDefaultResources(),
          getResources(),  VkComponent(),  VkComponent(), ~VkComponent(),
          hide(),  realize(),  manage(),  unmanage(), name(),  baseWidget(),
          okToQuit(),  isComponent(),  *(), _name,  _baseWidget,  _w,
          deleteCallback,


   Inherited from VkCallbackObject
          callCallbacks(),  VkCallbackObject(),  ~VkCallbackObject(),
          addCallback(),  addCallback(), removeCallback(),  removeCallback(),
          removeAllCallbacks(),  removeAllCallbacks(),  hasCallbacks(),
          cloneCallbacks(),  cloneCallback(),  cloneCallback(),


KNOWN DERIVED CLASSES
     VkForkIO

SEE ALSO
     VkComponent, VkCallbackObject, VkTextIO,
     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