summaryrefslogtreecommitdiff
path: root/xmloff/inc/forms/property_handler.hxx
blob: e495d45d65ddd9a0906a708eaed81dab05371b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX
#define INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX

#include "forms/property_ids.hxx"

#include <com/sun/star/uno/Any.hxx>

#include <rtl/ref.hxx>
#include <salhelper/simplereferenceobject.hxx>

#include <map>
#include <vector>

namespace xmloff
{

    typedef ::std::map< PropertyId, css::uno::Any >    PropertyValues;

    class PropertyHandlerBase : public ::salhelper::SimpleReferenceObject
    {
    public:
        /** retrieves the XML attribute value for the given property values
        */
        virtual OUString
            getAttributeValue( const PropertyValues& i_propertyValues ) const = 0;

        /** is a convenience method for XML attributes whose value comprises of only one UNO API property
        */
        virtual OUString
            getAttributeValue( const css::uno::Any& i_propertyValue ) const = 0;

        /** retrieves the values of the properties controlled by an XML attributed, described by a given attribute value
        */
        virtual bool
            getPropertyValues( const OUString& i_attributeValue, PropertyValues& o_propertyValues ) const = 0;

        virtual ~PropertyHandlerBase() override {}
    };

    //= PPropertyHandler
    typedef rtl::Reference< PropertyHandlerBase >    PPropertyHandler;

    //= PropertyHandlerFactory
    typedef PPropertyHandler (*PropertyHandlerFactory)( const PropertyId i_propertyId );

} // namespace xmloff

#endif // INCLUDED_XMLOFF_INC_FORMS_PROPERTY_HANDLER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */