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