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