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 AUTODOC_DSP_TXT_FLIST_HXX
25 #define AUTODOC_DSP_TXT_FLIST_HXX
26 
27 #include <iostream>
28 
29 
30 namespace ary
31 {
32     namespace cpp
33     {
34         class DisplayGate;
35     }
36 }
37 
38 
39 namespace autodoc
40 {
41 
42 class TextDisplay_FunctionList_Ifc
43 {
44   public:
~TextDisplay_FunctionList_Ifc()45     virtual			    ~TextDisplay_FunctionList_Ifc() {}
46 
47     /** Displays the names of all C++ functions and methods within the
48         given namespace (or the global namespace as default). All
49         subnamespaces are included.
50     */
51     virtual void        Run(
52                             ostream &           o_rStream,
53                             const ary::cpp::DisplayGate &
54                                                 i_rAryGate ) = 0; /// If i_pNamespace == 0, the global namespace is displayed.
55 };
56 
57 
58 }   // namespace autodoc
59 
60 #endif
61 
62