xref: /aoo4110/main/autodoc/inc/ary/info/ci_attag.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef ARY_INFO_CI_ATTAG_HXX
25*b1cdbd2cSJim Jagielski #define ARY_INFO_CI_ATTAG_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski // USED SERVICES
30*b1cdbd2cSJim Jagielski 	// BASE CLASSES
31*b1cdbd2cSJim Jagielski 	// COMPONENTS
32*b1cdbd2cSJim Jagielski 	// PARAMETERS
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski namespace ary
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski namespace info
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski 
41*b1cdbd2cSJim Jagielski class DocuText;
42*b1cdbd2cSJim Jagielski class DocuDisplay;
43*b1cdbd2cSJim Jagielski 
44*b1cdbd2cSJim Jagielski class AtTag
45*b1cdbd2cSJim Jagielski {
46*b1cdbd2cSJim Jagielski   public:
~AtTag()47*b1cdbd2cSJim Jagielski 	virtual				~AtTag() {}
48*b1cdbd2cSJim Jagielski 
49*b1cdbd2cSJim Jagielski     void                Set_HtmlUseInDocuText(
50*b1cdbd2cSJim Jagielski                             bool                i_bUseIt );
51*b1cdbd2cSJim Jagielski 	virtual bool	  	Add_SpecialMeaningToken(    /// @return false, if token was not sp�ecial.
52*b1cdbd2cSJim Jagielski 							const char *		i_sText,
53*b1cdbd2cSJim Jagielski 							intt				i_nNr ) = 0;
54*b1cdbd2cSJim Jagielski 	virtual void		Add_Token(
55*b1cdbd2cSJim Jagielski 							const char *		i_sText );
56*b1cdbd2cSJim Jagielski 	virtual void		Add_PotentialLink(
57*b1cdbd2cSJim Jagielski 							const char *		i_sText,
58*b1cdbd2cSJim Jagielski                             bool                i_bIsGlobal,
59*b1cdbd2cSJim Jagielski                             bool                i_bIsFunction );
60*b1cdbd2cSJim Jagielski 	virtual void		Add_Whitespace(
61*b1cdbd2cSJim Jagielski 							UINT8               i_nLength );
62*b1cdbd2cSJim Jagielski 	virtual void		Add_Eol();
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski 	virtual UINT8		NrOfSpecialMeaningTokens() const = 0;
65*b1cdbd2cSJim Jagielski 	virtual AtTag *		GetFollower() = 0;
66*b1cdbd2cSJim Jagielski 
67*b1cdbd2cSJim Jagielski     void                StoreAt(
68*b1cdbd2cSJim Jagielski                             DocuDisplay &       o_rDisplay ) const;
69*b1cdbd2cSJim Jagielski 	const DocuText &    CText() const;
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski   private:
72*b1cdbd2cSJim Jagielski     virtual void        do_StoreAt(
73*b1cdbd2cSJim Jagielski                             DocuDisplay &       o_rDisplay ) const;   // later becoming abstract
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski 	virtual DocuText *  Text() = 0;
76*b1cdbd2cSJim Jagielski };
77*b1cdbd2cSJim Jagielski 
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski 
80*b1cdbd2cSJim Jagielski // IMPLEMENTATION
81*b1cdbd2cSJim Jagielski 
82*b1cdbd2cSJim Jagielski inline void
StoreAt(DocuDisplay & o_rDisplay) const83*b1cdbd2cSJim Jagielski AtTag::StoreAt( DocuDisplay & o_rDisplay ) const
84*b1cdbd2cSJim Jagielski     { do_StoreAt(o_rDisplay); }
85*b1cdbd2cSJim Jagielski inline const DocuText &
CText() const86*b1cdbd2cSJim Jagielski AtTag::CText() const
87*b1cdbd2cSJim Jagielski     { DocuText * ret = const_cast< AtTag* >(this)->Text();
88*b1cdbd2cSJim Jagielski       csv_assert( ret != 0 );
89*b1cdbd2cSJim Jagielski       return *ret;
90*b1cdbd2cSJim Jagielski     }
91*b1cdbd2cSJim Jagielski 
92*b1cdbd2cSJim Jagielski 
93*b1cdbd2cSJim Jagielski }
94*b1cdbd2cSJim Jagielski }
95*b1cdbd2cSJim Jagielski 
96*b1cdbd2cSJim Jagielski #endif
97*b1cdbd2cSJim Jagielski 
98