Line data    Source code

       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_INC_FORMS_PROPERTY_HANDLER_HXX
      21             : #define INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX
      22             : 
      23             : #include "forms/property_ids.hxx"
      24             : 
      25             : #include <com/sun/star/uno/Any.hxx>
      26             : 
      27             : #include <rtl/ref.hxx>
      28             : 
      29             : #include <map>
      30             : #include <vector>
      31             : 
      32             : namespace xmloff
      33             : {
      34             : 
      35             :     typedef ::std::map< PropertyId, ::com::sun::star::uno::Any >    PropertyValues;
      36             : 
      37             :     //= IPropertyHandler
      38           0 :     class IPropertyHandler : public ::rtl::IReference
      39             :     {
      40             :     public:
      41             :         /** retrieves the XML attribute value for the given property values
      42             :         */
      43             :         virtual OUString
      44             :             getAttributeValue( const PropertyValues& i_propertyValues ) const = 0;
      45             : 
      46             :         /** is a convenience method for XML attributes whose value comprises of only one UNO API property
      47             :         */
      48             :         virtual OUString
      49             :             getAttributeValue( const ::com::sun::star::uno::Any& i_propertyValue ) const = 0;
      50             : 
      51             :         /** retrieves the values of the properties controlled by an XML attributed, described by a given attribute value
      52             :         */
      53             :         virtual bool
      54             :             getPropertyValues( const OUString& i_attributeValue, PropertyValues& o_propertyValues ) const = 0;
      55             : 
      56           0 :         virtual ~IPropertyHandler() { }
      57             :     };
      58             : 
      59             :     //= PPropertyHandler
      60             :     typedef ::rtl::Reference< IPropertyHandler >    PPropertyHandler;
      61             : 
      62             :     //= PropertyHandlerFactory
      63             :     typedef PPropertyHandler (*PropertyHandlerFactory)( const PropertyId i_propertyId );
      64             : 
      65             : } // namespace xmloff
      66             : 
      67             : #endif // INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX
      68             : 
      69             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */