cde/programs/dtinfo/DtMmdb/oliasdb/doc_hd.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 /*
  24  * $XConsortium: doc_hd.h /main/4 1996/06/11 17:28:52 cde-hal $
  25  *
  26  * Copyright (c) 1992 HAL Computer Systems International, Ltd.
  27  * All rights reserved.  Unpublished -- rights reserved under
  28  * the Copyright Laws of the United States.  USE OF A COPYRIGHT
  29  * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
  30  * OR DISCLOSURE.
  31  *
  32  * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
  33  * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
  34  * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
  35  * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
  36  * INTERNATIONAL, LTD.
  37  *
  38  *                         RESTRICTED RIGHTS LEGEND
  39  * Use, duplication, or disclosure by the Government is subject
  40  * to the restrictions as set forth in subparagraph (c)(l)(ii)
  41  * of the Rights in Technical Data and Computer Software clause
  42  * at DFARS 252.227-7013.
  43  *
  44  *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
  45  *                  1315 Dell Avenue
  46  *                  Campbell, CA  95008
  47  *
  48  */
  49
  50
  51 #ifndef _doc_hd_h
  52 #define _doc_hd_h 1
  53
  54 #include "object/tuple.h"
  55 #include "object/short_list.h"
  56 #include "object/pstring.h"
  57 #include "object/oid.h"
  58 #include "object/integer.h"
  59 #include "oliasdb/olias_consts.h"
  60 #include "api/smart_ptr.h"
  61
  62 #ifdef A16_BROWSER
  63 #define long_title title
  64 #endif
  65
  66 /*************************************/
  67 // The doc class
  68 /*************************************/
  69
  70 class doc : public tuple
  71 {
  72 public:
  73    doc() : tuple(NUM_DOC_FIELDS, DOC_CODE) {};
  74    virtual ~doc() {};
  75
  76    MMDB_SIGNATURES(doc);
  77
  78 protected:
  79    friend class doc_smart_ptr;
  80 };
  81
  82 typedef doc* docPtr;
  83
  84 /*************************************/
  85 /*************************************/
  86
  87
  88 class doc_smart_ptr : public smart_ptr
  89 {
  90 public:
  91    doc_smart_ptr(info_lib*, const char* base_name, const int seq_num);
  92    doc_smart_ptr(info_base* base_ptr, const int seq_num);
  93
  94    doc_smart_ptr(info_lib*, const char* ibase_name, const oid_t& toc_node_id);
  95    doc_smart_ptr(info_base* ibase_ptr, const oid_t& toc_node_id);
  96
  97    doc_smart_ptr(const oid_t& doc_id, info_lib*, const char* ibase_name);
  98    doc_smart_ptr(const oid_t& doc_id, info_base*);
  99
 100    virtual ~doc_smart_ptr() {};
 101
 102    oid_t  locator_id();
 103    const char*  short_title();
 104    const char*  long_title();
 105    short_list_handler* tab_list();
 106    int seq_num();  // seq number for Fulcrum.
 107    const char*  license_terms();
 108    unsigned int license_terms_size();
 109 };
 110
 111
 112
 113 #endif