offapi/com/sun/star/xml/input/XAttributes.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_xml_input_XAttributes_idl__
  20 #define __com_sun_star_xml_input_XAttributes_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25 module com { module sun { module star { module xml { module input {
  26
  27 /** An element's attributes
  28
  29     @internal
  30 */
  31 interface XAttributes : com::sun::star::uno::XInterface
  32 {
  33     /** Gets the number of attributes.
  34
  35         @return
  36                 number of attributes
  37     */
  38     long getLength();
  39
  40     /** Gets attribute index passing a QName.
  41
  42         @param qName
  43                QName
  44         @return
  45                 attribute index or -1, if not found
  46     */
  47     long getIndexByQName( [in] string qName );
  48
  49     /** Gets attribute index passing a namespace uid and a local name.
  50
  51         @param uid
  52                namespace uid
  53         @param localName
  54                local name
  55         @return
  56                 attribute index or -1, if not found
  57     */
  58     long getIndexByUidName( [in] long uid, [in] string localName );
  59
  60     /** Gets the QName of an attribute.
  61
  62         @param nIndex
  63                index
  64         @return
  65                 QName of attribute or empty string, if invalid index
  66     */
  67     string getQNameByIndex( [in] long nIndex );
  68
  69     /** Gets the namespace uid of an attribute.
  70
  71         @param nIndex
  72                index
  73         @return
  74                 namespace uid of attribute or -1, if invalid index
  75     */
  76     long getUidByIndex( [in] long nIndex );
  77
  78     /** Gets the local name of an attribute.
  79
  80         @param nIndex
  81                index
  82         @return
  83                 local name of attribute or empty string, if invalid index
  84     */
  85     string getLocalNameByIndex( [in] long nIndex );
  86
  87     /** Gets the value of an attribute.
  88
  89         @param nIndex
  90                index
  91         @return
  92                 value string or empty string, if invalid index
  93     */
  94     string getValueByIndex( [in] long nIndex );
  95
  96     /** For convenience: Gets the value of an attribute passing uid, local name.
  97
  98         @param uid
  99                namespace uid
 100         @param localName
 101                local name
 102         @return
 103                 value string or empty string, if invalid uid/local name
 104     */
 105     string getValueByUidName( [in] long uid, [in] string localName );
 106
 107     /** Gets the type of an attribute, if possible.
 108
 109         @param nIndex
 110                index
 111         @return
 112                 type of attribute (if possible, else empty string)
 113     */
 114     string getTypeByIndex( [in] long nIndex );
 115 };
 116
 117 }; }; }; }; };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */