xref: /trunk/main/autodoc/inc/ary_i/ci_atag2.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd) !
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_CI_ATAG2_HXX
25 #define ARY_CI_ATAG2_HXX
26 
27 
28 
29 // USED SERVICES
30     // BASE CLASSES
31     // COMPONENTS
32 #include <ary_i/ci_text2.hxx>
33     // PARAMETERS
34 
35 
36 
37 namespace ary
38 {
39 namespace inf
40 {
41 
42 
43 class DocumentationDisplay;
44 
45 class AtTag2
46 {
47   public:
~AtTag2()48     virtual             ~AtTag2() {}
49 
50     virtual void        DisplayAt(
51                             DocumentationDisplay &
52                                                 o_rDisplay ) const = 0;
53 
Title() const54     const char *        Title() const           { return sTitle; }
Text() const55     const DocuTex2 &    Text() const            { return aText; }
Access_Text()56     DocuTex2 &          Access_Text()           { return aText; }
57 
58   protected:
AtTag2(const char * i_sTitle)59                         AtTag2(
60                             const char *        i_sTitle)
61                                                 :   sTitle(i_sTitle) {}
62     String              sTitle;
63     DocuTex2            aText;
64 };
65 
66 
67 
68 // IMPLEMENTATION
69 
70 }   // namespace inf
71 }   // namespace ary
72 
73 
74 #endif
75