udkapi/com/sun/star/container/XHierarchicalName.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 module com {  module sun {  module star {  module container {
  22
  23
  24 /** specifies the fully qualified name of the object within a hierarchy.
  25
  26     <p>The name is generally globally unique in the hierarchy.  </p>
  27
  28     @see com::sun::star::container::XHierarchicalNameAccess
  29     @see com::sun::star::container::XNamed
  30  */
  31 published interface XHierarchicalName: com::sun::star::uno::XInterface
  32 {
  33
  34     /** @returns
  35                 the fully qualified hierarchical name of the object.
  36      */
  37     string getHierarchicalName();
  38
  39
  40     /** builds the hierarchical name of an object, given a relative name
  41
  42         <p>Can be used to find the name of a descendant object in the hierarchy
  43         without actually accessing it.  </p>
  44
  45         @see XHierarchicalNameAccess::hasByHierarchicalName
  46      */
  47     string composeHierarchicalName( [in] string aRelativeName )
  48             raises( com::sun::star::lang::IllegalArgumentException,
  49                     com::sun::star::lang::NoSupportException );
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */