offapi/com/sun/star/configuration/XDocumentation.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
  10 module com { module sun { module star { module configuration {
  11
  12 /* Is used to deliver documentation for the configuration.
  13
  14    <p>This interface is still unpublished and unstable.</p>
  15
  16    @since LibreOffice 24.2
  17 */
  18 interface XDocumentation {
  19     /** @returns
  20             the description for the requested object
  21
  22         @param aName
  23             the hierarchical name of the object.
  24
  25         @throws NoSuchElementException
  26             if an element under aName does not exist.
  27      */
  28     string getDescriptionByHierarchicalName( [in] string aName )
  29             raises( com::sun::star::container::NoSuchElementException );
  30
  31     /** @returns
  32             the type for the requested object
  33
  34         @param aName
  35             the hierarchical name of the object.
  36
  37         @throws NoSuchElementException
  38             if an element under aName does not exist.
  39
  40         @throws InvalidStateException
  41             when the type of the object could not be resolved.
  42      */
  43     type getTypeByHierarchicalName( [in] string aName )
  44             raises( com::sun::star::container::NoSuchElementException,
  45                     com::sun::star::util::InvalidStateException );
  46
  47     /** @returns
  48             whether the requested object was modified
  49
  50         @param aName
  51             the hierarchical name of the object.
  52
  53         @throws NoSuchElementException
  54             if an element under aName does not exist.
  55
  56         @throws InvalidStateException
  57             when the object has an invalid type
  58      */
  59     boolean getModifiedByHierarchicalName( [in] string aName )
  60             raises( com::sun::star::container::NoSuchElementException,
  61                     com::sun::star::util::InvalidStateException );
  62 };
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */