autodoc/inc/ary_i/disdocum.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_DISDOCUM_HXX
  30 #define ARY_DISDOCUM_HXX
  31
  32
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37     // PARAMETERS
  38
  39
  40 namespace csi
  41 {
  42 namespace dsapi
  43 {
  44 class DT_TextToken;
  45 class DT_MupType;
  46 class DT_MupMember;
  47 class DT_MupConst;
  48 class DT_Style;
  49 class DT_EOL;
  50 class DT_StdAtTag;
  51 class DT_SeeAlsoAtTag;
  52 class DT_ParameterAtTag;
  53 class DT_SinceAtTag;
  54 }   // namespace dsapi
  55 }   // namespace csi
  56
  57
  58 namespace ary
  59 {
  60 namespace inf
  61 {
  62
  63
  64
  65 class DocumentationDisplay
  66 {
  67   public:
  68
  69     virtual             ~DocumentationDisplay() { }
  70
  71     virtual void        Display_TextToken(
  72                             const csi::dsapi::DT_TextToken &
  73                                                 i_rToken ) = 0;
  74     virtual void        Display_White() = 0;
  75     virtual void        Display_MupType(
  76                             const csi::dsapi::DT_MupType &  i_rToken ) = 0;
  77     virtual void        Display_MupMember(
  78                             const csi::dsapi::DT_MupMember &
  79                                                 i_rToken ) = 0;
  80     virtual void        Display_MupConst(
  81                             const csi::dsapi::DT_MupConst &
  82                                                 i_rToken ) = 0;
  83     virtual void        Display_Style(
  84                             const csi::dsapi::DT_Style &    i_rToken ) = 0;
  85     virtual void        Display_EOL() = 0;
  86     virtual void        Display_StdAtTag(
  87                             const csi::dsapi::DT_StdAtTag &
  88                                                 i_rToken ) = 0;
  89     virtual void        Display_SeeAlsoAtTag(
  90                             const csi::dsapi::DT_SeeAlsoAtTag &
  91                                                 i_rToken ) = 0;
  92     virtual void        Display_ParameterAtTag(
  93                             const csi::dsapi::DT_ParameterAtTag &
  94                                                 i_rToken ) = 0;
  95     virtual void        Display_SinceAtTag(
  96                             const csi::dsapi::DT_SinceAtTag &
  97                                                 i_rToken ) = 0;
  98 };
  99
 100
 101 class DocuTag_Display : public DocumentationDisplay
 102 {
 103   public:
 104     // Dummies, implemented in source\ary_i\kernel\ci_atag2.cxx
 105     virtual void        Display_TextToken(
 106                             const csi::dsapi::DT_TextToken &
 107                                                 i_rToken );
 108     virtual void        Display_White();
 109     virtual void        Display_MupType(
 110                             const csi::dsapi::DT_MupType &  i_rToken );
 111     virtual void        Display_MupMember(
 112                             const csi::dsapi::DT_MupMember &
 113                                                 i_rToken );
 114     virtual void        Display_MupConst(
 115                             const csi::dsapi::DT_MupConst &
 116                                                 i_rToken );
 117     virtual void        Display_Style(
 118                             const csi::dsapi::DT_Style &    i_rToken );
 119     virtual void        Display_EOL();
 120 };
 121
 122 class DocuText_Display : public DocumentationDisplay
 123 {
 124   public:
 125     // Dummies, implemented in source\ary_i\kernel\ci_text2.cxx
 126     virtual void        Display_StdAtTag(
 127                             const csi::dsapi::DT_StdAtTag &
 128                                                 i_rToken );
 129     virtual void        Display_SeeAlsoAtTag(
 130                             const csi::dsapi::DT_SeeAlsoAtTag &
 131                                                 i_rToken );
 132     virtual void        Display_ParameterAtTag(
 133                             const csi::dsapi::DT_ParameterAtTag &
 134                                                 i_rToken );
 135     virtual void        Display_SinceAtTag(
 136                             const csi::dsapi::DT_SinceAtTag &
 137                                                 i_rToken );
 138 };
 139
 140
 141
 142 }   // namespace inf
 143 }   // namespace ary
 144
 145
 146 #endif
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */