xref: /aoo4110/main/autodoc/inc/ary_i/disdocum.hxx (revision b1cdbd2c)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_DISDOCUM_HXX
25 #define ARY_DISDOCUM_HXX
26 
27 
28 
29 // USED SERVICES
30 	// BASE CLASSES
31 	// COMPONENTS
32 	// PARAMETERS
33 
34 
35 namespace csi
36 {
37 namespace dsapi
38 {
39 class DT_TextToken;
40 class DT_MupType;
41 class DT_MupMember;
42 class DT_MupConst;
43 class DT_Style;
44 class DT_EOL;
45 class DT_StdAtTag;
46 class DT_SeeAlsoAtTag;
47 class DT_ParameterAtTag;
48 class DT_SinceAtTag;
49 }   // namespace dsapi
50 }   // namespace csi
51 
52 
53 namespace ary
54 {
55 namespace inf
56 {
57 
58 
59 
60 class DocumentationDisplay
61 {
62   public:
63 
~DocumentationDisplay()64 	virtual				~DocumentationDisplay() { }
65 
66 	virtual void	 	Display_TextToken(
67 							const csi::dsapi::DT_TextToken &
68 												i_rToken ) = 0;
69 	virtual void	 	Display_White() = 0;
70 	virtual void	 	Display_MupType(
71 							const csi::dsapi::DT_MupType &	i_rToken ) = 0;
72 	virtual void	 	Display_MupMember(
73 							const csi::dsapi::DT_MupMember &
74 												i_rToken ) = 0;
75 	virtual void	 	Display_MupConst(
76 							const csi::dsapi::DT_MupConst &
77 												i_rToken ) = 0;
78 	virtual void	 	Display_Style(
79 							const csi::dsapi::DT_Style &	i_rToken ) = 0;
80 	virtual void	 	Display_EOL() = 0;
81 	virtual void	 	Display_StdAtTag(
82 							const csi::dsapi::DT_StdAtTag &
83 												i_rToken ) = 0;
84 	virtual void	 	Display_SeeAlsoAtTag(
85 							const csi::dsapi::DT_SeeAlsoAtTag &
86 												i_rToken ) = 0;
87 	virtual void	 	Display_ParameterAtTag(
88 							const csi::dsapi::DT_ParameterAtTag &
89 												i_rToken ) = 0;
90 	virtual void	 	Display_SinceAtTag(
91 							const csi::dsapi::DT_SinceAtTag &
92 												i_rToken ) = 0;
93 };
94 
95 
96 class DocuTag_Display : public DocumentationDisplay
97 {
98   public:
99     // Dummies, implemented in source\ary_i\kernel\ci_atag2.cxx
100 	virtual void	 	Display_TextToken(
101 							const csi::dsapi::DT_TextToken &
102 												i_rToken );
103 	virtual void	 	Display_White();
104 	virtual void	 	Display_MupType(
105 							const csi::dsapi::DT_MupType &	i_rToken );
106 	virtual void	 	Display_MupMember(
107 							const csi::dsapi::DT_MupMember &
108 												i_rToken );
109 	virtual void	 	Display_MupConst(
110 							const csi::dsapi::DT_MupConst &
111 												i_rToken );
112 	virtual void	 	Display_Style(
113 							const csi::dsapi::DT_Style &	i_rToken );
114 	virtual void	 	Display_EOL();
115 };
116 
117 class DocuText_Display : public DocumentationDisplay
118 {
119   public:
120     // Dummies, implemented in source\ary_i\kernel\ci_text2.cxx
121 	virtual void	 	Display_StdAtTag(
122 							const csi::dsapi::DT_StdAtTag &
123 												i_rToken );
124 	virtual void	 	Display_SeeAlsoAtTag(
125 							const csi::dsapi::DT_SeeAlsoAtTag &
126 												i_rToken );
127 	virtual void	 	Display_ParameterAtTag(
128 							const csi::dsapi::DT_ParameterAtTag &
129 												i_rToken );
130 	virtual void	 	Display_SinceAtTag(
131 							const csi::dsapi::DT_SinceAtTag &
132 												i_rToken );
133 };
134 
135 
136 
137 }   // namespace inf
138 }   // namespace ary
139 
140 
141 #endif
142 
143