office-gobmx/offapi/com/sun/star/ucb/XPropertySetRegistry.idl
2012-01-05 09:18:17 +00:00

78 lines
2.8 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 __com_sun_star_ucb_XPropertySetRegistry_idl__
#define __com_sun_star_ucb_XPropertySetRegistry_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/ucb/XPersistentPropertySet.idl>
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A registry (storage medium) for persistent property sets.
@version 1.0
@author Kai Sommerfeld
@see XPersistentPropertySet
*/
published interface XPropertySetRegistry : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** creates a new or opens an existing property set in the registry.
@param key
The key to use for addressing the property set.
@param create
Indicates whether a new set shall be created in case there
does not already exist one for the given key.
@returns
The property set.
*/
com::sun::star::ucb::XPersistentPropertySet
openPropertySet( [in] string key, [in] boolean create );
//-------------------------------------------------------------------------
/** removes a property set from the registry.
@param key
The key to use for addressing the property set.
*/
[oneway] void removePropertySet( [in] string key );
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */