xref: /aoo42x/main/autodoc/inc/ary/doc/d_oldidldocu.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_DOC_D_OLDIDLDOCU_HXX
29*cdf0e10cSrcweir #define ARY_DOC_D_OLDIDLDOCU_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // BASE CLASSES
32*cdf0e10cSrcweir #include <ary/doc/d_node.hxx>
33*cdf0e10cSrcweir // USED SERVICES
34*cdf0e10cSrcweir #include <ary_i/ci_text2.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace ary
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir namespace inf
42*cdf0e10cSrcweir {
43*cdf0e10cSrcweir     class AtTag2;
44*cdf0e10cSrcweir     class DocuToken;
45*cdf0e10cSrcweir     class DocuTex2;
46*cdf0e10cSrcweir }
47*cdf0e10cSrcweir namespace doc
48*cdf0e10cSrcweir {
49*cdf0e10cSrcweir     using ::ary::inf::AtTag2;
50*cdf0e10cSrcweir     using ::ary::inf::DocuToken;
51*cdf0e10cSrcweir     using ::ary::inf::DocuTex2;
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir 
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir /** Wrapper for the old idl documentation format.
56*cdf0e10cSrcweir */
57*cdf0e10cSrcweir class OldIdlDocu : public Node
58*cdf0e10cSrcweir {
59*cdf0e10cSrcweir   public:
60*cdf0e10cSrcweir                         OldIdlDocu();
61*cdf0e10cSrcweir                         ~OldIdlDocu();
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     void                AddToken2Short(
64*cdf0e10cSrcweir                             DYN DocuToken &     let_drToken )
65*cdf0e10cSrcweir                                                 { aShort.AddToken(let_drToken); }
66*cdf0e10cSrcweir     void                AddToken2Description(
67*cdf0e10cSrcweir                             DYN DocuToken &     let_drToken )
68*cdf0e10cSrcweir                                                 { aDescription.AddToken(let_drToken); }
69*cdf0e10cSrcweir     void                AddToken2DeprecatedText(
70*cdf0e10cSrcweir                             DYN DocuToken &     let_drToken );
71*cdf0e10cSrcweir     void                AddAtTag(
72*cdf0e10cSrcweir                             DYN AtTag2 &        let_drAtTag )
73*cdf0e10cSrcweir                                                 { aTags.push_back(&let_drAtTag); }
74*cdf0e10cSrcweir     void                SetPublished()          { bIsPublished = true; }
75*cdf0e10cSrcweir     void                SetDeprecated()         { bIsDeprecated = true; }
76*cdf0e10cSrcweir     void                SetOptional()           { bIsOptional = true; }
77*cdf0e10cSrcweir     void                SetExternShort(
78*cdf0e10cSrcweir                             const DocuTex2 &    i_pExternShort )
79*cdf0e10cSrcweir                                                 { pExternShort = &i_pExternShort; }
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir     const DocuTex2 &    Short() const           { return pExternShort != 0 ? *pExternShort : aShort; }
82*cdf0e10cSrcweir     const DocuTex2 &    Description() const     { return aDescription; }
83*cdf0e10cSrcweir     const DocuTex2 &    DeprecatedText() const  { return aDeprecatedText; }
84*cdf0e10cSrcweir     const std::vector< AtTag2* > &
85*cdf0e10cSrcweir                         Tags() const            { return aTags; }
86*cdf0e10cSrcweir     bool                IsPublished() const     { return bIsPublished; }
87*cdf0e10cSrcweir     bool                IsDeprecated() const    { return bIsDeprecated; }
88*cdf0e10cSrcweir     bool                IsOptional() const      { return bIsOptional; }
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir   private:
91*cdf0e10cSrcweir     // Interface csv::ConstProcessorClient:
92*cdf0e10cSrcweir     virtual void        do_Accept(
93*cdf0e10cSrcweir                             csv::ProcessorIfc & io_processor ) const;
94*cdf0e10cSrcweir     // DATA
95*cdf0e10cSrcweir     DocuTex2            aShort;
96*cdf0e10cSrcweir     DocuTex2            aDescription;
97*cdf0e10cSrcweir     DocuTex2            aDeprecatedText;
98*cdf0e10cSrcweir     std::vector< AtTag2* >
99*cdf0e10cSrcweir                         aTags;
100*cdf0e10cSrcweir     const DocuTex2 *    pExternShort;
101*cdf0e10cSrcweir     bool                bIsPublished;
102*cdf0e10cSrcweir     bool                bIsDeprecated;
103*cdf0e10cSrcweir     bool                bIsOptional;
104*cdf0e10cSrcweir };
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir 
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir }   // namespace doc
110*cdf0e10cSrcweir }   // namespace ary
111*cdf0e10cSrcweir #endif
112