offapi/com/sun/star/ucb/XPropertySetRegistry.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XPropertySetRegistry_idl__
  20 #define __com_sun_star_ucb_XPropertySetRegistry_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XPersistentPropertySet.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** A registry (storage medium) for persistent property sets.
  29
  30      @version  1.0
  31      @author   Kai Sommerfeld
  32      @see      XPersistentPropertySet
  33   */
  34 published interface XPropertySetRegistry : com::sun::star::uno::XInterface
  35 {
  36     /** creates a new or opens an existing property set in the registry.
  37
  38         @param key
  39         The key to use for addressing the property set.
  40
  41         @param create
  42         Indicates whether a new set shall be created in case there
  43         does not already exist one for the given key.
  44
  45         @returns
  46         The property set.
  47       */
  48     com::sun::star::ucb::XPersistentPropertySet
  49     openPropertySet( [in] string key, [in] boolean create );
  50
  51     /** removes a property set from the registry.
  52
  53         @param key
  54         The key to use for addressing the property set.
  55       */
  56     void removePropertySet( [in] string key );
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */