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