xmloff/inc/forms/property_handler.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_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 #include <salhelper/simplereferenceobject.hxx>
  29
  30 #include <map>
  31 #include <vector>
  32
  33 namespace xmloff
  34 {
  35
  36     typedef ::std::map< PropertyId, css::uno::Any >    PropertyValues;
  37
  38     class PropertyHandlerBase : public ::salhelper::SimpleReferenceObject
  39     {
  40     public:
  41         /** is a convenience method for XML attributes whose value comprises of only one UNO API property
  42         */
  43         virtual OUString
  44             getAttributeValue( const css::uno::Any& i_propertyValue ) const = 0;
  45
  46         /** retrieves the values of the properties controlled by an XML attributed, described by a given attribute value
  47         */
  48         virtual bool
  49             getPropertyValues( const OUString& i_attributeValue, PropertyValues& o_propertyValues ) const = 0;
  50     };
  51
  52     //= PPropertyHandler
  53     typedef rtl::Reference< PropertyHandlerBase >    PPropertyHandler;
  54
  55     //= PropertyHandlerFactory
  56     typedef PPropertyHandler (*PropertyHandlerFactory)( const PropertyId i_propertyId );
  57
  58 } // namespace xmloff
  59
  60 #endif // INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */