Back to index

lightning-sunbird  0.9+nobinonly
txOutputFormat.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is TransforMiiX XSLT processor code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Peter Van der Beken <peterv@propagandism.org>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef TRANSFRMX_OUTPUTFORMAT_H
00040 #define TRANSFRMX_OUTPUTFORMAT_H
00041 
00042 #include "txList.h"
00043 #include "nsString.h"
00044 
00045 enum txOutputMethod {
00046     eMethodNotSet,
00047     eXMLOutput,
00048     eHTMLOutput,
00049     eTextOutput
00050 };
00051 
00052 enum txThreeState {
00053     eNotSet,
00054     eFalse,
00055     eTrue
00056 };
00057 
00058 class txOutputFormat {
00059 public:
00060     txOutputFormat();
00061     ~txOutputFormat();
00062 
00063     // "Unset" all values
00064     void reset();
00065 
00066     // Merges in the values of aOutputFormat, members that already
00067     // have a value in this txOutputFormat will not be changed.
00068     void merge(txOutputFormat& aOutputFormat);
00069 
00070     // Sets members that have no value to their default value.
00071     void setFromDefaults();
00072 
00073     // The XSLT output method, which can be "xml", "html", or "text"
00074     txOutputMethod mMethod;
00075 
00076     // The xml version number that should be used when serializing
00077     // xml documents
00078     nsString mVersion;
00079 
00080     // The XML character encoding that should be used when serializing
00081     // xml documents
00082     nsString mEncoding;
00083 
00084     // Signals if we should output an XML declaration
00085     txThreeState mOmitXMLDeclaration;
00086 
00087     // Signals if we should output a standalone document declaration
00088     txThreeState mStandalone;
00089 
00090     // The public Id for creating a DOCTYPE
00091     nsString mPublicId;
00092 
00093     // The System Id for creating a DOCTYPE
00094     nsString mSystemId;
00095 
00096     // The elements whose text node children should be output as CDATA
00097     txList mCDATASectionElements;
00098 
00099     // Signals if output should be indented
00100     txThreeState mIndent;
00101 
00102     // The media type of the output
00103     nsString mMediaType;
00104 };
00105 
00106 #endif