autodoc/source/display/inc/toolkit/htmlfile.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: htmlfile.hxx,v $
  10  * $Revision: 1.5 $
  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_HTMLFILE_HXX
  32 #define ADC_DISPLAY_HTMLFILE_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37 #include <udm/html/htmlitem.hxx>
  38     // PARAMETERS
  39 #include <cosv/ploc.hxx>
  40
  41 namespace csv
  42 {
  43      class File;
  44 }
  45
  46 /** Represents an HTML output file.
  47 */
  48 class DocuFile_Html
  49 {
  50   public:
  51     // LIFECYCLE
  52                         DocuFile_Html();
  53
  54     void                                SetLocation(
  55                             const csv::ploc::Path &
  56                                                 i_rFilePath );
  57     void                SetTitle(
  58                             const char *        i_sTitle );
  59     void                SetRelativeCssPath(
  60                             const char *        i_sCssFile_relativePath );
  61     void                SetCopyright(
  62                             const char *        i_sCopyright );
  63     void                EmptyBody();
  64
  65     Html::Body &                Body()                                  { return aBodyData; }
  66     bool                        CreateFile();
  67
  68   private:
  69     void                                WriteHeader(
  70                             csv::File &                 io_aFile );
  71     void                                WriteBody(
  72                             csv::File &                 io_aFile );
  73     // DATA
  74     String              sFilePath;
  75     String              sTitle;
  76     String              sLocation;
  77     String              sStyle;
  78     String              sCssFile;
  79     String              sCopyright;
  80
  81     Html::Body                  aBodyData;
  82     StreamStr           aBuffer;
  83 };
  84
  85
  86
  87 #endif
  88
  89