cde/programs/dtinfo/dtinfo/src/Marks/MarkBase.hh

   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 libraries 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 /*
  24  * $XConsortium: MarkBase.hh /main/3 1996/06/11 16:29:16 cde-hal $
  25  *
  26  * Copyright (c) 1992 HaL Computer Systems, Inc.  All rights reserved.
  27  * UNPUBLISHED -- rights reserved under the Copyright Laws of the United
  28  * States.  Use of a copyright notice is precautionary only and does not
  29  * imply publication or disclosure.
  30  *
  31  * This software contains confidential information and trade secrets of HaL
  32  * Computer Systems, Inc.  Use, disclosure, or reproduction is prohibited
  33  * without the prior express written permission of HaL Computer Systems, Inc.
  34  *
  35  *                         RESTRICTED RIGHTS LEGEND
  36  * Use, duplication, or disclosure by the Government is subject to
  37  * restrictions as set forth in subparagraph (c)(l)(ii) of the Rights in
  38  * Technical Data and Computer Software clause at DFARS 252.227-7013.
  39  *                        HaL Computer Systems, Inc.
  40  *                  1315 Dell Avenue, Campbell, CA  95008
  41  *
  42  */
  43
  44 #include "UAS.hh"
  45
  46 template <class T> class xList;
  47 class Mark;
  48 struct Anchor;
  49
  50 class MarkBase
  51 {
  52 public:
  53   static MarkBase *open (const char *filename, bool read_only);
  54   static MarkBase *create (const char *filename, bool read_only,
  55                            const char *format);
  56
  57   virtual ~MarkBase();
  58
  59   virtual UAS_Pointer<Mark> create_mark (UAS_Pointer<UAS_Common> &, const Anchor &,
  60                                      const char *name, const char *notes) = 0;
  61
  62   virtual void get_marks (UAS_Pointer<UAS_Common> &doc_ptr,
  63                           xList<UAS_Pointer<Mark> > &list) = 0;
  64
  65   virtual void get_all_marks (xList<UAS_Pointer<Mark> > &list) = 0;
  66
  67   virtual bool read_only() = 0;
  68
  69   typedef MarkBase * (*open_func_t) (const char *filename, bool read_only);
  70   static int register_open_func (open_func_t open_func);
  71
  72   typedef MarkBase * (*mb_create_func_t) (const char *filename, bool read_only);
  73   static int register_create_func (mb_create_func_t create_func,
  74                                    const char *format);
  75 };