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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_DISPLAY_HTMLFILE_HXX
  21 #define ADC_DISPLAY_HTMLFILE_HXX
  22
  23 // USED SERVICES
  24     // BASE CLASSES
  25     // COMPONENTS
  26 #include <udm/html/htmlitem.hxx>
  27     // PARAMETERS
  28 #include <cosv/ploc.hxx>
  29
  30 namespace csv
  31 {
  32      class File;
  33 }
  34
  35 /** Represents an HTML output file.
  36 */
  37 class DocuFile_Html
  38 {
  39   public:
  40     // LIFECYCLE
  41                         DocuFile_Html();
  42
  43     void                SetLocation(
  44                             const csv::ploc::Path &
  45                                                 i_rFilePath );
  46     void                SetTitle(
  47                             const char *        i_sTitle );
  48     void                SetRelativeCssPath(
  49                             const char *        i_sCssFile_relativePath );
  50     void                SetCopyright(
  51                             const char *        i_sCopyright );
  52     void                EmptyBody();
  53
  54     Html::Body &        Body()                  { return aBodyData; }
  55     bool                CreateFile();
  56
  57   private:
  58     void                WriteHeader(
  59                             csv::File &         io_aFile );
  60     void                WriteBody(
  61                             csv::File &         io_aFile );
  62     // DATA
  63     String              sFilePath;
  64     String              sTitle;
  65     String              sLocation;
  66     String              sStyle;
  67     String              sCssFile;
  68     String              sCopyright;
  69
  70     Html::Body          aBodyData;
  71     StreamStr           aBuffer;
  72 };
  73
  74
  75
  76 #endif
  77
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */