offapi/com/sun/star/configuration/DefaultProvider.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
  20
  21
  22 module com { module sun { module star { module configuration {
  23
  24
  25 /**
  26     is a ConfigurationProvider, that is
  27     the default ConfigurationProvider for its
  28     com::sun::star::uno::XComponentContext.
  29
  30     <p>This object is accessible as singleton
  31     theDefaultProvider</p>.
  32
  33     @since OOo 1.1.2
  34 */
  35 published service DefaultProvider
  36 {
  37
  38     /** characterizes the functionality.
  39       */
  40     service ConfigurationProvider ;
  41
  42     /**Provides refresh capabilities, data can be refreshed from the backend(s) into
  43        the in-memory cache.
  44     */
  45     [optional] interface com::sun::star::util::XRefreshable;
  46
  47     /** Enables the data to be flushed from the in-memory cache to the backend(s).
  48      */
  49     [optional] interface com::sun::star::util::XFlushable;
  50
  51     /** Enable setting/getting locale for Provider
  52
  53         @since OOo 2.0
  54      */
  55
  56     [optional] interface com::sun::star::lang::XLocalizable;
  57
  58     /** Property to enable/disable asynchronous write-back from in-memory cache to backend(s)
  59
  60         @since OOo 2.0
  61      */
  62
  63     [optional,property] boolean EnableAsync;
  64
  65 } ;
  66
  67
  68 } ; } ; } ; } ;
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */