xref: /AOO41X/main/autodoc/inc/ary_i/ci_text2.hxx (revision 1c78a5d6c0093dece4c096ba53051800fbad6e33)
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_CINFO_CI_TEXT2_HXX
25 #define ARY_CINFO_CI_TEXT2_HXX
26 
27 
28 
29 // USED SERVICES
30     // BASE CLASSES
31     // COMPONENTS
32     // PARAMETERS
33 
34 
35 namespace ary
36 {
37 namespace inf
38 {
39 
40 
41 class DocumentationDisplay;
42 
43 
44 class DocuToken
45 {
46   public:
~DocuToken()47     virtual             ~DocuToken() {}
48     virtual void        DisplayAt(
49                             DocumentationDisplay &
50                                                 o_rDisplay ) const = 0;
51     virtual bool        IsWhiteOnly() const = 0;
52 };
53 
54 
55 class DocuTex2
56 {
57   public:
58     typedef std::vector< DocuToken * >  TokenList;
59 
60                         DocuTex2();
61     virtual             ~DocuTex2();
62 
63     virtual void        DisplayAt(
64                             DocumentationDisplay &
65                                                 o_rDisplay ) const;
66     void                AddToken(
67                             DYN DocuToken &     let_drToken );
68 
Tokens() const69     const TokenList &   Tokens() const          { return aTokens; }
70     bool                IsEmpty() const;
71     const String &      TextOfFirstToken() const;
72 
73     String &            Access_TextOfFirstToken();
74 
75   private:
76     TokenList           aTokens;
77 };
78 
79 
80 
81 // IMPLEMENTATION
82 
83 }   // namespace inf
84 }   // namespace ary
85 
86 
87 #endif
88 
89