offapi/com/sun/star/xml/input/XNamespaceMapping.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 #ifndef __com_sun_star_xml_input_XNamespaceMapping_idl__
  21 #define __com_sun_star_xml_input_XNamespaceMapping_idl__
  22
  23 #include <com/sun/star/container/NoSuchElementException.idl>
  24
  25
  26 module com { module sun { module star { module xml { module input {
  27
  28 /** Interface to map XML namespace URI strings to ordinals (URI-id, short uid).
  29
  30     @internal
  31 */
  32 interface XNamespaceMapping : com::sun::star::uno::XInterface
  33 {
  34     /** Creates a unique ordinal passing an XML namespace URI.
  35
  36         @param uri
  37                XML namespace URI
  38         @return
  39                 uid
  40      */
  41     long getUidByUri( [in] string uri );
  42
  43     /** Gets the corresponding XML namespace URI passing a uid (created using
  44         getUidByUri()).
  45
  46         @param uid
  47                uid
  48         @return
  49                XML namespace URI
  50     */
  51     string getUriByUid( [in] long uid )
  52         raises (com::sun::star::container::NoSuchElementException);
  53 };
  54
  55 }; }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */