diff options
Diffstat (limited to '')
| -rw-r--r-- | include/xmloff/prhdlfac.hxx | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/include/xmloff/prhdlfac.hxx b/include/xmloff/prhdlfac.hxx new file mode 100644 index 000000000..2ad3f3d7a --- /dev/null +++ b/include/xmloff/prhdlfac.hxx @@ -0,0 +1,106 @@ +/* -*- 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_PRHDLFAC_HXX +#define INCLUDED_XMLOFF_PRHDLFAC_HXX + +#include <xmloff/dllapi.h> +#include <sal/types.h> + +#include <salhelper/simplereferenceobject.hxx> +#include <memory> + +class XMLPropertyHandler; + +/** + This class is a base-class to create XMLPropertyHandler. + It creates PropertyHandler for given XML-types and store + them in an internal cache. They'll be deleted at destruction- + time. + For create your own PropertyHandler for specific XML-types + you have to override the virtual method GetPropertyHandler + ( see below ). +*/ +class XMLOFF_DLLPUBLIC XMLPropertyHandlerFactory : public salhelper::SimpleReferenceObject +{ + struct Impl; + std::unique_ptr<Impl> mpImpl; + + XMLPropertyHandlerFactory( const XMLPropertyHandlerFactory& ) = delete; + XMLPropertyHandlerFactory& operator= ( const XMLPropertyHandlerFactory& ) = delete; + +public: + XMLPropertyHandlerFactory(); + virtual ~XMLPropertyHandlerFactory() override; + + /** + This method retrieves a PropertyHandler for the given XML-type. + To extend this method for more XML-types override this method + like the example below. If you call the method of the base-class + you get propertyhandler for basic-XML-types ( e.g. for color, percent, ... ). + After that you could create your new XML-types. After creating a new type + you have to put the pointer into the cache via the method + PutHdlCache( sal_Int32 , XMLPropertyHandler* ). + + virtual const XMLPropertyHandler* GetPropertyHandler( sal_Int32 nType ) const + { + XMLPropertyHandler* pHdl = XMLPropertyHandlerFactory::GetPropertyHandler( nType ); + + if( !pHdl ) + { + switch( nType ) + { + case XML_TYPE_XYZ : + pHdl = new XML_xyz_PropHdl; + break; + case ... + : + : + } + + if( pHdl ) + PutHdlCache( nType, pHdl ); + } + + return pHdl; + } + */ + virtual const XMLPropertyHandler* GetPropertyHandler( sal_Int32 nType ) const; + + /** helper method to statically create a property handler; this will not + * use the handler cache. This method should only be called in special + * circumstances; calling GetPropertyHandler is almost always + * preferable. */ + static std::unique_ptr<XMLPropertyHandler> CreatePropertyHandler( sal_Int32 nType ); + +protected: + /** Retrieves a PropertyHandler from the internal cache */ + const XMLPropertyHandler* GetHdlCache( sal_Int32 nType ) const; + /** Puts a PropertyHandler into the internal cache */ + void PutHdlCache( sal_Int32 nType, const XMLPropertyHandler* pHdl ) const; + +private: + /** Retrieves ( creates if necessary ) PropertyHandler for + basic XML-types */ + SAL_DLLPRIVATE const XMLPropertyHandler* GetBasicHandler( sal_Int32 nType ) const; +}; + +#endif // INCLUDED_XMLOFF_PRHDLFAC_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |