cde/programs/nsgmls/EventGenerator.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these librararies and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /* $XConsortium: EventGenerator.h /main/1 1996/07/29 16:51:29 cde-hp $ */
  24 // Copyright (c) 1994 James Clark
  25 // See the file COPYING for copying permission.
  26
  27 #ifndef EventGenerator_INCLUDED
  28 #define EventGenerator_INCLUDED 1
  29
  30 #ifdef __GNUG__
  31 #pragma interface
  32 #endif
  33
  34 #include "SGMLApplication.h"
  35
  36 class SP_API EventGenerator {
  37 public:
  38   virtual ~EventGenerator();
  39   // Can be called at most once for any object.
  40   // Returns number of errors.
  41   virtual unsigned run(SGMLApplication &) = 0;
  42   // may be called at any time
  43   virtual void inhibitMessages(bool);
  44   // may be called at any time, even from another thread
  45   virtual void halt() = 0;
  46   // called after run
  47   virtual EventGenerator *
  48     makeSubdocEventGenerator(const SGMLApplication::Char *systemId,
  49                              size_t systemIdLength);
  50 };
  51
  52 #endif /* not EventGenerator_INCLUDED */