xref: /AOO41X/main/autodoc/source/display/inc/toolkit/out_tree.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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 ADC_DISPLAY_OUT_TREE_HXX
29*cdf0e10cSrcweir #define ADC_DISPLAY_OUT_TREE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir 
32*cdf0e10cSrcweir // USED SERVICES
33*cdf0e10cSrcweir     // BASE CLASSES
34*cdf0e10cSrcweir     // COMPONENTS
35*cdf0e10cSrcweir #include "out_position.hxx"
36*cdf0e10cSrcweir     // PARAMETERS
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir namespace output
40*cdf0e10cSrcweir {
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir inline const char *
43*cdf0e10cSrcweir ModuleFileName()
44*cdf0e10cSrcweir { return "module-ix.html"; }
45*cdf0e10cSrcweir inline const char *
46*cdf0e10cSrcweir IndexFilesDirName()
47*cdf0e10cSrcweir { return "index-files"; }
48*cdf0e10cSrcweir inline const char *
49*cdf0e10cSrcweir IndexFile_A()
50*cdf0e10cSrcweir { return "index-1.html"; }
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir class Tree
54*cdf0e10cSrcweir {
55*cdf0e10cSrcweir   public:
56*cdf0e10cSrcweir     // LIFECYCLE
57*cdf0e10cSrcweir                         Tree();
58*cdf0e10cSrcweir                         ~Tree();
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir     // OPERATIONS
61*cdf0e10cSrcweir     void                Set_Overview(
62*cdf0e10cSrcweir                             const StringVector &
63*cdf0e10cSrcweir                                                 i_path,
64*cdf0e10cSrcweir                             const String &      i_sFileName );
65*cdf0e10cSrcweir     Node &              Set_NamesRoot(
66*cdf0e10cSrcweir                             const StringVector &
67*cdf0e10cSrcweir                                                 i_path );
68*cdf0e10cSrcweir     Node &              Set_IndexRoot(
69*cdf0e10cSrcweir                             const StringVector &
70*cdf0e10cSrcweir                                                 i_path );
71*cdf0e10cSrcweir     Node &              Set_ProjectsRoot(
72*cdf0e10cSrcweir                             const StringVector &
73*cdf0e10cSrcweir                                                 i_path );
74*cdf0e10cSrcweir     Node &              Provide_Node(
75*cdf0e10cSrcweir                             const StringVector &
76*cdf0e10cSrcweir                                                 i_path );
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir     // ACCESS
79*cdf0e10cSrcweir     Node &              RootNode()              { return *pRoot; }
80*cdf0e10cSrcweir     Node &              NamesRootNode()	    	{ return *pNamesRoot; }
81*cdf0e10cSrcweir     Node &              IndexRootNode()			{ return *pIndexRoot; }
82*cdf0e10cSrcweir     Node &              ProjectsRootNode()		{ return *pProjectsRoot; }
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir     Position            Root()                  { return Position(*pRoot); }
85*cdf0e10cSrcweir     Position            Overview()				{ return aOverview; }
86*cdf0e10cSrcweir     Position            NamesRoot()				{ return Position(*pNamesRoot); }
87*cdf0e10cSrcweir     Position            IndexRoot()				{ return Position(*pIndexRoot); }
88*cdf0e10cSrcweir     Position            ProjectsRoot()			{ return Position(*pProjectsRoot); }
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir   private:
91*cdf0e10cSrcweir     // forbidden:
92*cdf0e10cSrcweir                         Tree(const Tree&);
93*cdf0e10cSrcweir     Tree &              operator=(const Tree&);
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir     // DATA
96*cdf0e10cSrcweir     Dyn<Node>           pRoot;
97*cdf0e10cSrcweir     Node *              pNamesRoot;
98*cdf0e10cSrcweir     Node *              pIndexRoot;
99*cdf0e10cSrcweir     Node *              pProjectsRoot;
100*cdf0e10cSrcweir     Position            aOverview;
101*cdf0e10cSrcweir };
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir // IMPLEMENTATION
105*cdf0e10cSrcweir 
106*cdf0e10cSrcweir inline Node &
107*cdf0e10cSrcweir Tree::Provide_Node( const StringVector & i_path )
108*cdf0e10cSrcweir     { return pRoot->Provide_Child(i_path); }
109*cdf0e10cSrcweir 
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir inline void
112*cdf0e10cSrcweir Tree::Set_Overview( const StringVector & i_path,
113*cdf0e10cSrcweir                     const String &		 i_sFileName )
114*cdf0e10cSrcweir     { aOverview.Set(Provide_Node(i_path), i_sFileName); }
115*cdf0e10cSrcweir 
116*cdf0e10cSrcweir inline Node &
117*cdf0e10cSrcweir Tree::Set_NamesRoot( const StringVector & i_path )
118*cdf0e10cSrcweir     { pNamesRoot = &Provide_Node(i_path);
119*cdf0e10cSrcweir 	  return *pNamesRoot; }
120*cdf0e10cSrcweir 
121*cdf0e10cSrcweir inline Node &
122*cdf0e10cSrcweir Tree::Set_IndexRoot( const StringVector & i_path )
123*cdf0e10cSrcweir     { pIndexRoot = &Provide_Node(i_path);
124*cdf0e10cSrcweir 	  return *pIndexRoot; }
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir inline Node &
127*cdf0e10cSrcweir Tree::Set_ProjectsRoot( const StringVector & i_path )
128*cdf0e10cSrcweir     { pProjectsRoot = &Provide_Node(i_path);
129*cdf0e10cSrcweir 	  return *pProjectsRoot; }
130*cdf0e10cSrcweir 
131*cdf0e10cSrcweir 
132*cdf0e10cSrcweir 
133*cdf0e10cSrcweir }   // namespace output
134*cdf0e10cSrcweir 
135*cdf0e10cSrcweir 
136*cdf0e10cSrcweir #endif
137