231 lines
11 KiB
C++
231 lines
11 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: viewaccess.hxx,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* 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_VIEWACCESS_HXX_
|
|
#define CONFIGMGR_VIEWACCESS_HXX_
|
|
|
|
#include "viewnode.hxx"
|
|
#include "viewstrategy.hxx"
|
|
#include <rtl/ref.hxx>
|
|
|
|
//-----------------------------------------------------------------------------
|
|
namespace configmgr
|
|
{
|
|
//-----------------------------------------------------------------------------
|
|
namespace configuration { class NodeRef; }
|
|
//-----------------------------------------------------------------------------
|
|
namespace view
|
|
{
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class ViewTreeAccess
|
|
{
|
|
rtl::Reference< ViewStrategy > m_xStrategy;
|
|
configuration::Tree * m_tree;
|
|
|
|
public:
|
|
explicit ViewTreeAccess(configuration::Tree * tree):
|
|
m_xStrategy(tree->getViewBehavior()), m_tree(tree) {}
|
|
|
|
rtl::Reference< view::ViewStrategy > getViewBehavior() { return m_xStrategy; }
|
|
public:
|
|
configuration::NodeData* nodeData(configuration::NodeRef const& _aNodeArg) const;
|
|
configuration::NodeData* nodeData(unsigned int _aNodePos) const;
|
|
|
|
Node makeNode(configuration::NodeRef const& _aNodeArg) const { return Node(m_tree,nodeData(_aNodeArg)); }
|
|
Node makeNode(unsigned int _aNodePos) const { return Node(m_tree,nodeData(_aNodePos)); }
|
|
|
|
bool isSetNode (configuration::NodeRef const& _aNodeArg) const { return makeNode(_aNodeArg).isSetNode(); }
|
|
bool isGroupNode(configuration::NodeRef const& _aNodeArg) const { return makeNode(_aNodeArg).isGroupNode(); }
|
|
bool isValueNode(configuration::NodeRef const& _aNodeArg) const { return makeNode(_aNodeArg).isValueNode(); }
|
|
|
|
bool isSetNodeAt (unsigned int _aNodeArg) const { return makeNode(_aNodeArg).isSetNode(); }
|
|
bool isGroupNodeAt(unsigned int _aNodeArg) const { return makeNode(_aNodeArg).isGroupNode(); }
|
|
bool isValueNodeAt(unsigned int _aNodeArg) const { return makeNode(_aNodeArg).isValueNode(); }
|
|
|
|
SetNode toSetNode (configuration::NodeRef const& _aNodeArg) const
|
|
{ return SetNode (makeNode(_aNodeArg)); }
|
|
|
|
GroupNode toGroupNode(configuration::NodeRef const& _aNodeArg) const
|
|
{ return GroupNode(makeNode(_aNodeArg)); }
|
|
|
|
ValueNode toValueNode(configuration::NodeRef const& _aNodeArg) const
|
|
{ return ValueNode(makeNode(_aNodeArg)); }
|
|
|
|
SetNode getSetNodeAt (unsigned int _aNodeArg) const
|
|
{ return SetNode (makeNode(_aNodeArg)); }
|
|
|
|
GroupNode getGroupNodeAt(unsigned int _aNodeArg) const
|
|
{ return GroupNode(makeNode(_aNodeArg)); }
|
|
|
|
ValueNode getValueNodeAt(unsigned int _aNodeArg) const
|
|
{ return ValueNode(makeNode(_aNodeArg)); }
|
|
// node attributes
|
|
public:
|
|
/// retrieve the name of the node
|
|
rtl::OUString getName(configuration::NodeRef const& _aNode) const
|
|
{ return m_xStrategy->getName(makeNode(_aNode)); }
|
|
|
|
/// retrieve the attributes of the node
|
|
node::Attributes getAttributes(configuration::NodeRef const& _aNode) const
|
|
{ return m_xStrategy->getAttributes(makeNode(_aNode)); }
|
|
|
|
/// retrieve the name of the tree root
|
|
rtl::OUString getRootName() const
|
|
{ return m_xStrategy->getName( getRootNode(m_tree) ); }
|
|
|
|
/// retrieve the attributes of the tree root
|
|
node::Attributes getRootAttributes() const
|
|
{ return m_xStrategy->getAttributes( getRootNode(m_tree) ); }
|
|
|
|
// tracking pending changes
|
|
public:
|
|
void collectChanges(configuration::NodeChanges& rChanges) const
|
|
{ m_xStrategy->collectChanges(m_tree,rChanges); }
|
|
|
|
bool hasChanges() const
|
|
{ return m_xStrategy->hasChanges(m_tree); }
|
|
|
|
bool hasChanges(configuration::NodeRef const& _aNode) const
|
|
{ return m_xStrategy->hasChanges(makeNode(_aNode)); }
|
|
|
|
void markChanged(configuration::NodeRef const& _aNode)
|
|
{ m_xStrategy->markChanged(makeNode(_aNode)); }
|
|
|
|
// commit protocol
|
|
public:
|
|
std::auto_ptr<SubtreeChange> preCommitChanges(std::vector< rtl::Reference<configuration::ElementTree> >& _rRemovedElements)
|
|
{ return m_xStrategy->preCommitChanges(m_tree,_rRemovedElements); }
|
|
|
|
void finishCommit(SubtreeChange& rRootChange)
|
|
{ m_xStrategy->finishCommit(m_tree,rRootChange); }
|
|
|
|
void revertCommit(SubtreeChange& rRootChange)
|
|
{ m_xStrategy->revertCommit(m_tree,rRootChange); }
|
|
|
|
void recoverFailedCommit(SubtreeChange& rRootChange)
|
|
{ m_xStrategy->recoverFailedCommit(m_tree,rRootChange); }
|
|
|
|
// notification protocol
|
|
public:
|
|
/// Adjust the internal representation after external changes to the original data - build NodeChangeInformation objects for notification
|
|
void adjustToChanges(configuration::NodeChangesInformation& rLocalChanges, configuration::NodeRef const& _aNode, SubtreeChange const& aExternalChange)
|
|
{ m_xStrategy->adjustToChanges(rLocalChanges,makeNode(_aNode), aExternalChange); }
|
|
|
|
// visitor dispatch
|
|
public:
|
|
configuration::GroupMemberVisitor::Result dispatchToValues(GroupNode const& _aNode, configuration::GroupMemberVisitor& _aVisitor) const
|
|
{ return m_xStrategy->dispatchToValues(_aNode,_aVisitor); }
|
|
|
|
/// Call <code>aVisitor.visit(aElement)</code> for each element in this set until SetNodeVisitor::DONE is returned.
|
|
configuration::SetNodeVisitor::Result dispatchToElements(SetNode const& _aNode, configuration::SetNodeVisitor& _aVisitor) const
|
|
{ return m_xStrategy->dispatchToElements(_aNode,_aVisitor); }
|
|
|
|
// value (element) node specific operations
|
|
public:
|
|
/// Does this node assume its default value
|
|
/// retrieve the current value of this node
|
|
com::sun::star::uno::Any getValue(ValueNode const& _aNode) const
|
|
{ return m_xStrategy->getValue(_aNode); }
|
|
#if OSL_DEBUG_LEVEL > 0
|
|
/// get the type of this value
|
|
com::sun::star::uno::Type getValueType(ValueNode const& _aNode) const
|
|
{ return m_xStrategy->getValueType(_aNode); }
|
|
#endif
|
|
|
|
// group node specific operations
|
|
public:
|
|
/// does this hold a child value of the given name
|
|
bool hasValue(GroupNode const& _aNode, rtl::OUString const& _aName) const
|
|
{ return m_xStrategy->hasValue(_aNode,_aName); }
|
|
|
|
/// does this hold a child value
|
|
bool hasValue(GroupNode const& _aNode) const
|
|
{ return m_xStrategy->hasValue(_aNode); }
|
|
|
|
/// are defaults for this node available ?
|
|
bool areValueDefaultsAvailable(GroupNode const& _aNode) const
|
|
{ return m_xStrategy->areValueDefaultsAvailable(_aNode); }
|
|
|
|
/// retrieve data for the child value of the given name
|
|
configuration::ValueMemberNode getValue(GroupNode const& _aNode, rtl::OUString const& _aName) const
|
|
{ return m_xStrategy->getValue(_aNode,_aName); }
|
|
|
|
/// retrieve data for updating the child value of the given name
|
|
configuration::ValueMemberUpdate getValueForUpdate(GroupNode const & _aNode, rtl::OUString const& _aName) const
|
|
{ return m_xStrategy->getValueForUpdate(_aNode,_aName); }
|
|
|
|
// set node specific operations
|
|
public:
|
|
/// does this set contain any elements (loads elements if needed)
|
|
bool isEmpty(SetNode const& _aNode) const
|
|
{ return m_xStrategy->isEmpty(_aNode); }
|
|
|
|
/// does this set contain an element named <var>aName</var> (loads elements if needed)
|
|
configuration::SetEntry findElement(SetNode const& _aNode, rtl::OUString const& aName) const
|
|
{ return m_xStrategy->findElement(_aNode,aName); }
|
|
|
|
/// does this set contain an element named <var>aName</var> (and is that element loaded ?)
|
|
configuration::SetEntry findAvailableElement(SetNode const& _aNode, rtl::OUString const& aName) const
|
|
{ return m_xStrategy->findAvailableElement(_aNode,aName); }
|
|
|
|
/// insert a new entry into this set
|
|
void insertElement(SetNode const& _aNode, rtl::OUString const& aName, configuration::SetEntry const& aNewEntry)
|
|
{ m_xStrategy->insertElement(_aNode,aName,aNewEntry); }
|
|
|
|
/// remove an existing entry into this set
|
|
void removeElement(SetNode const& _aNode, rtl::OUString const& aName)
|
|
{ m_xStrategy->removeElement(_aNode,aName); }
|
|
|
|
/** Create a Subtree change as 'diff' which allows transforming the set to its default state
|
|
(given that <var>_rDefaultTree</var> points to a default instance of this set)
|
|
<p>Ownership of added trees should be transferred to the SubtreeChange.</p>
|
|
*/
|
|
std::auto_ptr<SubtreeChange> differenceToDefaultState(SetNode const& _aNode, ISubtree& _rDefaultTree)
|
|
{ return m_xStrategy->differenceToDefaultState(_aNode,_rDefaultTree); }
|
|
|
|
/// Get the template that describes elements of this set
|
|
rtl::Reference<configuration::Template> getElementTemplate(SetNode const& _aNode) const
|
|
{ return m_xStrategy->getElementTemplate(_aNode); }
|
|
|
|
/// Get a template provider that can create new elements for this set
|
|
configuration::TemplateProvider getTemplateProvider(SetNode const& _aNode) const
|
|
{ return m_xStrategy->getTemplateProvider(_aNode); }
|
|
|
|
// changing state/strategy
|
|
public:
|
|
// replace m_xStrategy by a direct ViewStrategy (commiting changes to the data), if possible
|
|
// void makeDirect ();
|
|
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif // CONFIGMGR_VIEWACCESS_HXX_
|