offapi/com/sun/star/xml/input/XAttributes.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAttributes.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #if ! defined INCLUDED__com_sun_star_xml_input_XAttributes_idl__
  31 #define INCLUDED__com_sun_star_xml_input_XAttributes_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35
  36 module com { module sun { module star { module xml { module input {
  37
  38 /** An element's attributes
  39
  40     @internal
  41 */
  42 interface XAttributes : com::sun::star::uno::XInterface
  43 {
  44     /** Gets the number of attributes.
  45
  46         @return
  47                 number of attributes
  48     */
  49     long getLength();
  50
  51     /** Gets attribute index passing a QName.
  52
  53         @param qName
  54                QName
  55         @return
  56                 attribute index or -1, if not found
  57     */
  58     long getIndexByQName( [in] string qName );
  59
  60     /** Gets attribute index passing a namespace uid and a localname.
  61
  62         @param uid
  63                namespace uid
  64         @param localName
  65                localname
  66         @return
  67                 attribute index or -1, if not found
  68     */
  69     long getIndexByUidName( [in] long uid, [in] string localName );
  70
  71     /** Gets the QName of an attribute.
  72
  73         @param nIndex
  74                index
  75         @return
  76                 QName of attribute or empty string, if invalid index
  77     */
  78     string getQNameByIndex( [in] long nIndex );
  79
  80     /** Gets the namespace uid of an attribute.
  81
  82         @param nIndex
  83                index
  84         @return
  85                 namespace uid of attribute or -1, if invalid index
  86     */
  87     long getUidByIndex( [in] long nIndex );
  88
  89     /** Gets the localname of an attribute.
  90
  91         @param nIndex
  92                index
  93         @return
  94                 localname of attribute or empty string, if invalid index
  95     */
  96     string getLocalNameByIndex( [in] long nIndex );
  97
  98     /** Gets the value of an attribute.
  99
 100         @param nIndex
 101                index
 102         @return
 103                 value string or empty string, if invalid index
 104     */
 105     string getValueByIndex( [in] long nIndex );
 106
 107     /** For convenience: Gets the value of an attribute passing uid, localname.
 108
 109         @param uid
 110                namespace uid
 111         @param localName
 112                localname
 113         @return
 114                 value string or empty string, if invalid uid/localname
 115     */
 116     string getValueByUidName( [in] long uid, [in] string localName );
 117
 118     /** Gets the type of an attribute, if possible.
 119
 120         @param nIndex
 121                index
 122         @return
 123                 type of attribute (if possible, else empty string)
 124     */
 125     string getTypeByIndex( [in] long nIndex );
 126 };
 127
 128 }; }; }; }; };
 129
 130 #endif