xref: /AOO41X/main/autodoc/source/display/inc/toolkit/hf_funcdecl.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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 ADC_DISPLAY_HF_FUNCDECL_HXX
29 #define ADC_DISPLAY_HF_FUNCDECL_HXX
30 
31 
32 // USED SERVICES
33 	// BASE CLASSES
34 #include <toolkit/htmlfactory.hxx>
35 	// COMPONENTS
36 	// PARAMETERS
37 
38 
39 #if 0   // old
40 /** @resp
41     Provides three cells to put in a function declaration.
42 */
43 class HF_FunctionDeclaration : public HtmlMaker
44 {
45   public:
46                         HF_FunctionDeclaration(
47                             Xml::Element &      o_rParent );
48     virtual             ~HF_FunctionDeclaration();
49 
50     /// Inserts empty line in 2nd and 3rd cell and returns first.
51     Xml::Element &      Add_ReturnLine();
52 
53     /** Inserts empty line in 1st cell, "raises (" in 2nd
54         and returns 3rd.
55     */
56     Xml::Element &      Add_RaisesLine(
57                             const char *        i_sRaisesText,
58                             bool                i_bSuppressExtraLine = false );
59 
60     Xml::Element &      Front()                 { return *pFront; }
61     Xml::Element &      Types()                 { return *pTypes; }
62     Xml::Element &      Names()                 { return *pNames; }
63 
64   private:
65     Xml::Element *      pFront;
66     Xml::Element *      pTypes;
67     Xml::Element *      pNames;
68 };
69 #endif // 0  old
70 
71 class HF_FunctionDeclaration : public HtmlMaker
72 {
73   public:
74                         HF_FunctionDeclaration(
75                             Xml::Element &      o_rParent,
76                             const String &      i_sRaisesText );
77     virtual             ~HF_FunctionDeclaration();
78 
79     // OPERATIONS
80     Xml::Element &      ReturnCell();
81     Xml::Element &      NameCell();
82     Xml::Element &      NewParamTypeCell();
83     Xml::Element &      ParamNameCell();
84     Xml::Element &      ExceptionCell();
85 
86   private:
87     Html::TableRow &    ParameterLine();
88 
89     // DATA
90     String              sRaisesText;
91     Html::Table *       pTable;
92     Xml::Element *      pReturnCell;
93     Xml::Element *      pNameCell;
94     Html::TableRow *    pParameterLine;
95     Xml::Element *      pLastParameterCell;
96     Xml::Element *      pExceptionCell;
97 };
98 
99 
100 // IMPLEMENTATION
101 
102 
103 
104 #endif
105