autodoc/source/display/inc/toolkit/hf_funcdecl.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hf_funcdecl.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_DISPLAY_HF_FUNCDECL_HXX
  32 #define ADC_DISPLAY_HF_FUNCDECL_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <toolkit/htmlfactory.hxx>
  38     // COMPONENTS
  39     // PARAMETERS
  40
  41
  42 #if 0   // old
  43 /** @resp
  44     Provides three cells to put in a function declaration.
  45 */
  46 class HF_FunctionDeclaration : public HtmlMaker
  47 {
  48   public:
  49                         HF_FunctionDeclaration(
  50                             Xml::Element &      o_rParent );
  51     virtual             ~HF_FunctionDeclaration();
  52
  53     /// Inserts empty line in 2nd and 3rd cell and returns first.
  54     Xml::Element &      Add_ReturnLine();
  55
  56     /** Inserts empty line in 1st cell, "raises (" in 2nd
  57         and returns 3rd.
  58     */
  59     Xml::Element &      Add_RaisesLine(
  60                             const char *        i_sRaisesText,
  61                             bool                i_bSuppressExtraLine = false );
  62
  63     Xml::Element &      Front()                 { return *pFront; }
  64     Xml::Element &      Types()                 { return *pTypes; }
  65     Xml::Element &      Names()                 { return *pNames; }
  66
  67   private:
  68     Xml::Element *      pFront;
  69     Xml::Element *      pTypes;
  70     Xml::Element *      pNames;
  71 };
  72 #endif // 0  old
  73
  74 class HF_FunctionDeclaration : public HtmlMaker
  75 {
  76   public:
  77                         HF_FunctionDeclaration(
  78                             Xml::Element &      o_rParent,
  79                             const String &      i_sRaisesText );
  80     virtual             ~HF_FunctionDeclaration();
  81
  82     // OPERATIONS
  83     Xml::Element &      ReturnCell();
  84     Xml::Element &      NameCell();
  85     Xml::Element &      NewParamTypeCell();
  86     Xml::Element &      ParamNameCell();
  87     Xml::Element &      ExceptionCell();
  88
  89   private:
  90     Html::TableRow &    ParameterLine();
  91
  92     // DATA
  93     String              sRaisesText;
  94     Html::Table *       pTable;
  95     Xml::Element *      pReturnCell;
  96     Xml::Element *      pNameCell;
  97     Html::TableRow *    pParameterLine;
  98     Xml::Element *      pLastParameterCell;
  99     Xml::Element *      pExceptionCell;
 100 };
 101
 102
 103 // IMPLEMENTATION
 104
 105
 106
 107 #endif