office-gobmx/configmgr/source/api2/setaccess.hxx
2003-03-19 15:20:19 +00:00

223 lines
7.8 KiB
C++

/*************************************************************************
*
* $RCSfile: setaccess.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: hr $ $Date: 2003-03-19 16:18:37 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_API_SETACCESS_HXX_
#define CONFIGMGR_API_SETACCESS_HXX_
#ifndef _COM_SUN_STAR_CONTAINER_XHIERARCHICALNAME_HPP_
#include <com/sun/star/container/XHierarchicalName.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_
#include <com/sun/star/container/XNameAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XHIERARCHICALNAMEACCESS_HPP_
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XCONTAINER_HPP_
#include <com/sun/star/container/XContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_CONFIGURATION_XTEMPLATECONTAINER_HPP_
#include <com/sun/star/configuration/XTemplateContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XEXACTNAME_HPP_
#include <com/sun/star/beans/XExactName.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTY_HPP_
#include <com/sun/star/beans/XProperty.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSETINFO_HPP_
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#endif
#ifndef _COM_SUN_STAR_UTIL_XSTRINGESCAPE_HPP_
#include <com/sun/star/util/XStringEscape.hpp>
#endif
#ifndef _CPPUHELPER_IMPLBASE9_HXX_
#include <cppuhelper/implbase9.hxx>
#endif
namespace configmgr
{
namespace css = ::com::sun::star;
namespace uno = ::com::sun::star::uno;
using rtl::OUString;
namespace configapi { class NodeSetInfoAccess; }
/** implements the (read-only) interfaces supported by a set node
within the configuration tree.
<p> Is an interface adapter around <type scope='configmgr::configapi'>NodeAccess</type>.</p>
*/
class BasicSetAccess
: public ::cppu::ImplHelper9
< css::container::XNameAccess
, css::container::XHierarchicalName
, css::container::XHierarchicalNameAccess
, css::container::XContainer
, css::beans::XExactName
, css::beans::XProperty
, css::beans::XPropertySetInfo
, css::configuration::XTemplateContainer
, css::util::XStringEscape
>
{
protected:
// Destructors
virtual ~BasicSetAccess() {}
public:
// Interface methods
// XHierarchicalName
virtual OUString SAL_CALL
getHierarchicalName( )
throw(uno::RuntimeException);
virtual OUString SAL_CALL
composeHierarchicalName( const OUString& aRelativeName )
throw(css::lang::IllegalArgumentException, css::lang::NoSupportException,
uno::RuntimeException);
// XElementAccess, base class of XNameAccess
virtual uno::Type SAL_CALL
getElementType( )
throw(uno::RuntimeException);
virtual sal_Bool SAL_CALL
hasElements( )
throw(uno::RuntimeException);
// XNameAccess
virtual uno::Any SAL_CALL
getByName( const OUString& aName )
throw(css::container::NoSuchElementException, css::lang::WrappedTargetException,
uno::RuntimeException);
virtual uno::Sequence< OUString > SAL_CALL
getElementNames( )
throw( uno::RuntimeException);
virtual sal_Bool SAL_CALL
hasByName( const OUString& aName )
throw(uno::RuntimeException);
// XHierarchicalNameAccess
virtual uno::Any SAL_CALL
getByHierarchicalName( const OUString& aName )
throw(css::container::NoSuchElementException, uno::RuntimeException);
virtual sal_Bool SAL_CALL
hasByHierarchicalName( const OUString& aName )
throw(uno::RuntimeException);
// XContainer
virtual void SAL_CALL
addContainerListener( const uno::Reference< css::container::XContainerListener >& xListener )
throw(uno::RuntimeException);
virtual void SAL_CALL
removeContainerListener( const uno::Reference< css::container::XContainerListener >& xListener )
throw(uno::RuntimeException);
// XExactName
virtual OUString SAL_CALL
getExactName( const OUString& aApproximateName )
throw(uno::RuntimeException);
// XProperty
virtual css::beans::Property SAL_CALL
getAsProperty( )
throw(uno::RuntimeException);
// XPropertySetInfo
virtual uno::Sequence< css::beans::Property > SAL_CALL
getProperties( )
throw (uno::RuntimeException);
virtual css::beans::Property SAL_CALL
getPropertyByName( const OUString& aName )
throw (css::beans::UnknownPropertyException, uno::RuntimeException);
virtual sal_Bool SAL_CALL
hasPropertyByName( const OUString& Name )
throw (uno::RuntimeException);
// XTemplateContainer
OUString SAL_CALL
getElementTemplateName( )
throw(uno::RuntimeException);
// XStringEscape
OUString SAL_CALL
escapeString( const OUString& aString )
throw(css::lang::IllegalArgumentException, uno::RuntimeException);
OUString SAL_CALL
unescapeString( const OUString& aEscapedString )
throw(css::lang::IllegalArgumentException, uno::RuntimeException);
protected:
virtual configapi::NodeSetInfoAccess& getNode() = 0;
};
}
#endif // CONFIGMGR_API_SETACCESS_HXX_