autodoc/inc/ary_i/disdocum.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_DISDOCUM_HXX
  21 #define ARY_DISDOCUM_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27     // COMPONENTS
  28     // PARAMETERS
  29
  30
  31 namespace csi
  32 {
  33 namespace dsapi
  34 {
  35 class DT_TextToken;
  36 class DT_MupType;
  37 class DT_MupMember;
  38 class DT_MupConst;
  39 class DT_Style;
  40 class DT_StdAtTag;
  41 class DT_SeeAlsoAtTag;
  42 class DT_ParameterAtTag;
  43 class DT_SinceAtTag;
  44 }   // namespace dsapi
  45 }   // namespace csi
  46
  47
  48 namespace ary
  49 {
  50 namespace inf
  51 {
  52
  53
  54
  55 class DocumentationDisplay
  56 {
  57   public:
  58
  59     virtual             ~DocumentationDisplay() { }
  60
  61     virtual void        Display_TextToken(
  62                             const csi::dsapi::DT_TextToken &
  63                                                 i_rToken ) = 0;
  64     virtual void        Display_White() = 0;
  65     virtual void        Display_MupType(
  66                             const csi::dsapi::DT_MupType &  i_rToken ) = 0;
  67     virtual void        Display_MupMember(
  68                             const csi::dsapi::DT_MupMember &
  69                                                 i_rToken ) = 0;
  70     virtual void        Display_MupConst(
  71                             const csi::dsapi::DT_MupConst &
  72                                                 i_rToken ) = 0;
  73     virtual void        Display_Style(
  74                             const csi::dsapi::DT_Style &    i_rToken ) = 0;
  75     virtual void        Display_EOL() = 0;
  76     virtual void        Display_StdAtTag(
  77                             const csi::dsapi::DT_StdAtTag &
  78                                                 i_rToken ) = 0;
  79     virtual void        Display_SeeAlsoAtTag(
  80                             const csi::dsapi::DT_SeeAlsoAtTag &
  81                                                 i_rToken ) = 0;
  82     virtual void        Display_ParameterAtTag(
  83                             const csi::dsapi::DT_ParameterAtTag &
  84                                                 i_rToken ) = 0;
  85     virtual void        Display_SinceAtTag(
  86                             const csi::dsapi::DT_SinceAtTag &
  87                                                 i_rToken ) = 0;
  88 };
  89
  90
  91 class DocuTag_Display : public DocumentationDisplay
  92 {
  93   public:
  94     // Dummies, implemented in source\ary_i\kernel\ci_atag2.cxx
  95     virtual void        Display_TextToken(
  96                             const csi::dsapi::DT_TextToken &
  97                                                 i_rToken );
  98     virtual void        Display_White();
  99     virtual void        Display_MupType(
 100                             const csi::dsapi::DT_MupType &  i_rToken );
 101     virtual void        Display_MupMember(
 102                             const csi::dsapi::DT_MupMember &
 103                                                 i_rToken );
 104     virtual void        Display_MupConst(
 105                             const csi::dsapi::DT_MupConst &
 106                                                 i_rToken );
 107     virtual void        Display_Style(
 108                             const csi::dsapi::DT_Style &    i_rToken );
 109     virtual void        Display_EOL();
 110 };
 111
 112 class DocuText_Display : public DocumentationDisplay
 113 {
 114   public:
 115     // Dummies, implemented in source\ary_i\kernel\ci_text2.cxx
 116     virtual void        Display_StdAtTag(
 117                             const csi::dsapi::DT_StdAtTag &
 118                                                 i_rToken );
 119     virtual void        Display_SeeAlsoAtTag(
 120                             const csi::dsapi::DT_SeeAlsoAtTag &
 121                                                 i_rToken );
 122     virtual void        Display_ParameterAtTag(
 123                             const csi::dsapi::DT_ParameterAtTag &
 124                                                 i_rToken );
 125     virtual void        Display_SinceAtTag(
 126                             const csi::dsapi::DT_SinceAtTag &
 127                                                 i_rToken );
 128 };
 129
 130
 131
 132 }   // namespace inf
 133 }   // namespace ary
 134
 135
 136 #endif
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */