ui.h

Go to the documentation of this file.

// Copyright (C) 2006 Bryan Jacobson <bryanjacobson@users.sourceforge.net>
// This program is licensed under the terms of the GNU General Public License
// version 2, as published by the Free Software Foundation.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

#ifndef UI_h
#define UI_h

// =============================================================
// Class UI implements a command line user interface.

// Responsibilities:
//   <li> Print output text.
//   <li> Receive input text.

// Collaborator classes:
//   <li> ArchiveDialog??


// @author Bryan Jacobson
// @version 0.1
// =============================================================
class UI
{
  public:
      // Object constructor
    UI(); // Constructor
      // Handles all initialization.
    void Init();
      // Output text (print text to stdout)
    void OutputText(char *text); 
      // Prompt then get input text from stdin.
      // Note: 1. If EOF is encountered, return NULL. 2. The pointer
      // returned refers to a buffer that is overwritten on each successive
      // call to InputText().
    char *InputText();
  private:
    void CleanInput(char *buf);
};

#endif // UI_h

---