include/xmloff/xmlprhdl.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 INCLUDED_XMLOFF_XMLPRHDL_HXX
  21 #define INCLUDED_XMLOFF_XMLPRHDL_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <rtl/ustring.hxx>
  26
  27 namespace com{ namespace sun{ namespace star{ namespace uno{ class Any; } } } }
  28
  29 class SvXMLUnitConverter;
  30
  31
  32 /** Abstract base-class for different XML-types. Derivations of this class
  33     knows how to compare, im/export a special XML-type
  34 */
  35 class XMLOFF_DLLPUBLIC XMLPropertyHandler
  36 {
  37
  38 public:
  39     // Just needed for virtual destruction
  40     virtual ~XMLPropertyHandler();
  41
  42     /** Compares two Any's in case of the given XML-data-type.
  43         By default the Any-equal-operator is called. */
  44     virtual bool equals( const css::uno::Any& r1, const css::uno::Any& r2 ) const;
  45
  46     /** Imports the given value according to the XML-data-type corresponding to
  47         the derived class.
  48         @retval true if the value was successfully converted to Any
  49         @retval false if the value was not recognised (warning will be printed)
  50      */
  51     virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const =0;
  52     /// Exports the given value according to the XML-data-type corresponding to
  53     /// the derived class.
  54     virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const =0;
  55 };
  56
  57 #endif // INCLUDED_XMLOFF_XMLPRHDL_HXX
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */