lotuswordpro/source/filter/lwpfilter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  * Circle object.
  59  ************************************************************************/
  60 #ifndef _LWPFILTER_HXX
  61 #define _LWPFILTER_HXX
  62
  63 #include <cppuhelper/implbase1.hxx>
  64 #include <cppuhelper/implbase4.hxx>
  65 #include <cppuhelper/factory.hxx>
  66
  67 #include <com/sun/star/document/XFilter.hpp>
  68 #include <com/sun/star/document/XImporter.hpp>
  69 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
  70 #include <com/sun/star/xml/sax/SAXException.hpp>
  71 #include <com/sun/star/lang/XServiceInfo.hpp>
  72 #include <com/sun/star/io/XInputStream.hpp>
  73 #include <com/sun/star/document/XExtendedFilterDetection.hpp>
  74 #include <com/sun/star/text/XTextDocument.hpp>
  75 #include <tools/stream.hxx>
  76
  77 using namespace ::rtl;
  78 using namespace ::cppu;
  79 using namespace ::com::sun::star::lang;
  80 using namespace ::com::sun::star::io;
  81 using namespace ::com::sun::star::registry;
  82 using namespace ::com::sun::star::document;
  83 using namespace ::com::sun::star::beans;
  84 using namespace ::com::sun::star::xml::sax;
  85 using namespace ::com::sun::star::uno;
  86 using namespace ::com::sun::star::text;
  87 using namespace ::com::sun::star;
  88
  89 /**
  90  * @brief
  91  * Implements the XFilter interface.
  92  * This is not the entry for the filter, but a proto of LwpFilterImportFilter.
  93  */
  94 class LWPFilterReader : public WeakImplHelper1< XFilter >
  95 {
  96 public:
  97     LWPFilterReader();
  98     ~LWPFilterReader();
  99
 100 public:
 101     /**
 102      * @descr   loading the file. It's call be SfxObejctShell::ImportFrom.
 103      * @param   aDescriptor the parameters include file URL or XInputStream obejct, from which the filter can
 104      *          get which file to import.
 105      */
 106     virtual sal_Bool SAL_CALL filter( const Sequence< PropertyValue >& aDescriptor )
 107         throw( RuntimeException );
 108
 109     /**
 110      * @descr   stop loading the file.
 111      */
 112     virtual void SAL_CALL cancel() throw (com::sun::star::uno::RuntimeException);
 113
 114     /**
 115      * @descr   get the XDocumentHandler interface.
 116      */
 117     void setDocumentHandler( uno::Reference< XDocumentHandler >& xHandler )
 118     {
 119         m_DocumentHandler = xHandler;
 120     }
 121
 122 private:
 123     uno::Reference< XDocumentHandler > m_DocumentHandler;
 124 };
 125
 126 /**
 127  * @brief
 128  * Main entry for the xml filter framework.
 129  * It's called by SfxObjectShell::ImportFrom.
 130  */
 131 class LWPFilterImportFilter : public WeakImplHelper4< XFilter, XImporter, XServiceInfo, XExtendedFilterDetection >
 132 {
 133 public:
 134     LWPFilterImportFilter( const uno::Reference< XMultiServiceFactory >& xFact );
 135     ~LWPFilterImportFilter();
 136
 137 public:
 138     /**
 139      * @descr   see LWPFilterReader::filter.
 140      */
 141     virtual sal_Bool SAL_CALL filter( const Sequence< PropertyValue >& aDescriptor )
 142         throw( RuntimeException );
 143
 144     /**
 145      * @descr   see LWPFilterReader::cancel.
 146      */
 147     virtual void SAL_CALL cancel() throw (com::sun::star::uno::RuntimeException);
 148
 149     // XImporter
 150     virtual void SAL_CALL setTargetDocument( const uno::Reference< XComponent >& xDoc)
 151         throw( IllegalArgumentException, RuntimeException );
 152
 153     // XServiceInfo
 154     OUString SAL_CALL getImplementationName() throw ();
 155
 156     Sequence< OUString > SAL_CALL getSupportedServiceNames(void) throw ();
 157
 158     sal_Bool SAL_CALL supportsService(const OUString& ServiceName) throw ();
 159
 160     /**
 161      * @descr   function of interface XExtendedFilterDetection. If this interface is registered, it will be called whenever
 162      *          a file is to be loaded.
 163      */
 164     virtual OUString SAL_CALL detect( ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& Descriptor ) throw (::com::sun::star::uno::RuntimeException);
 165
 166 public:
 167     uno::Reference< XFilter > rFilter;
 168     uno::Reference< XImporter > rImporter;
 169 };
 170
 171 //test code
 172 int ReadWordproFile(SvStream &rStream, uno::Reference<XDocumentHandler>& XDoc);
 173
 174 #endif
 175
 176 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */