office-gobmx/configmgr/source/api2/apifactory.hxx
Rüdiger Timm 936b45ee76 INTEGRATION: CWS changefileheader (1.9.16); FILE MERGED
2008/04/01 15:06:30 thb 1.9.16.3: #i85898# Stripping all external header guards
2008/04/01 12:27:09 thb 1.9.16.2: #i85898# Stripping all external header guards
2008/03/31 12:22:35 rt 1.9.16.1: #i87441# Change license header to LPGL v3.
2008-04-11 10:47:11 +00:00

133 lines
5.5 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: apifactory.hxx,v $
* $Revision: 1.10 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CONFIGMGR_API_FACTORY_HXX_
#define CONFIGMGR_API_FACTORY_HXX_
#include "options.hxx"
#include "utility.hxx"
#include <rtl/ref.hxx>
#include <vos/ref.hxx>
#include <cppuhelper/typeprovider.hxx>
namespace configmgr
{
namespace configuration
{
class Name;
class NodeID;
class NodeRef;
class Tree;
class ElementRef;
class ElementTree;
class Template;
typedef rtl::Reference<Template> TemplateHolder;
}
namespace configapi
{
namespace uno = com::sun::star::uno;
typedef uno::XInterface UnoInterface;
typedef uno::Reference< uno::XInterface > UnoInterfaceRef;
typedef uno::Any UnoAny;
class ApiTreeImpl;
class NodeElement;
class InnerElement;
class TreeElement;
class SetElement;
class RootElement;
// used to register objects
class ObjectRegistry;
typedef rtl::Reference<ObjectRegistry> ObjectRegistryHolder;
typedef cppu::OImplementationId UnoTunnelID;
// used to create UNO objects
class Factory : Noncopyable
{
ObjectRegistryHolder m_pRegistry;
UnoTunnelID const m_aTunnelID;
private:
/// return the element _without_ acquiring it
NodeElement* implFind(configuration::NodeID const& aNode);
public:
Factory(ObjectRegistryHolder pRegistry);
virtual ~Factory();
UnoInterfaceRef makeUnoElement(configuration::Tree const& aTree, configuration::NodeRef const& aNode);
UnoInterfaceRef findUnoElement(configuration::NodeID const& aNode);
UnoInterfaceRef makeUnoGroupMember(configuration::Tree const& aTree, configuration::NodeRef const& aNode);
UnoInterfaceRef makeUnoSetElement(configuration::ElementTree const& aTree);
NodeElement* makeElement(configuration::Tree const& aTree, configuration::NodeRef const& aNode);
NodeElement* findElement(configuration::NodeID const& aNode);
NodeElement* makeGroupMember(configuration::Tree const& aTree, configuration::NodeRef const& aNode);
TreeElement* makeAccessRoot(configuration::Tree const& aTree, RequestOptions const& _aOptions);
SetElement* makeSetElement(configuration::ElementTree const& aTree);
SetElement* findSetElement(configuration::ElementRef const& aElement);
/// check for the existence of an element
sal_Bool hasElement(configuration::NodeID const& _rNode) { return NULL != implFind(_rNode); }
void revokeElement(configuration::NodeID const& aNode);
void revokeElement(configuration::NodeID const& aNode, NodeElement& rElement);
SetElement* extractSetElement(UnoAny const& aElement);
bool tunnelSetElement(sal_Int64& nSomething, SetElement& rElement, uno::Sequence< sal_Int8 > const& aTunnelID);
// registry operations
static ApiTreeImpl const* findDescendantTreeImpl(configuration::NodeID const& aNode, ApiTreeImpl const* pImpl);
protected:
void doRegisterElement(configuration::NodeID const& aNode, NodeElement* pElement);
void doRevokeElement(configuration::NodeID const& aNode, NodeElement* pElement);
uno::Sequence< sal_Int8 > doGetElementTunnelID() const { return m_aTunnelID.getImplementationId(); }
virtual NodeElement* doCreateGroupMember(configuration::Tree const& aTree, configuration::NodeRef const& aNode, configuration::Template* pSetElementTemplate) = 0;
virtual TreeElement* doCreateAccessRoot(configuration::Tree const& aTree, configuration::Template* pSetElementTemplate, vos::ORef< OOptions >const& _xOptions) = 0;
virtual SetElement* doCreateSetElement(configuration::ElementTree const& aTree, configuration::Template* pSetElementTemplate) = 0;
static ApiTreeImpl& getImplementation(NodeElement& pElement);
private:
static configuration::TemplateHolder implGetSetElementTemplate(configuration::Tree const& aTree, configuration::NodeRef const& aNode);
static UnoInterfaceRef implToUno(NodeElement* pNode);
void implHaveNewElement(configuration::NodeID aNodeID, NodeElement* pNode);
};
}
}
#endif // CONFIGMGR_API_FACTORY_HXX_