/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XAttributeList_idl__
#define __com_sun_star_xml_sax_XAttributeList_idl__

#include <com/sun/star/uno/XInterface.idl>

//=============================================================================

module com {  module sun {  module star {  module xml {  module sax {

//=============================================================================

/** specifies an element's attributes.

    <p>This interface describes a name-type-value triple which describes a
    single attribute of a tag. Implementors are encouraged to implement the
    <type scope="com::sun::star::util">XCloneable</type> interface also to
    allow the user to make a copy of the instance.

    </p>
    <p>This interface is an IDL version of the Java interface
    <em>org.xml.sax.AttributeList</em>.</p>
 */
published interface XAttributeList: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                    the number of attributes in this list.
     */
    short getLength();

    //-------------------------------------------------------------------------

    /** @returns
                    the name of an attribute in this list (by position).
     */
    string getNameByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the type of an attribute in the list (by position).
                    Non-validating parsers may return CDATA only.
     */
    string getTypeByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the type of an attribute in the list (by name).
                    Non-validating parsers may return CDATA only.
     */
    string getTypeByName( [in] string aName );

    //-------------------------------------------------------------------------

    /** @returns
                    the value of an attribute in the list (by position).
     */
    string getValueByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the value of an attribute in the list (by name).
     */
    string getValueByName( [in] string aName );
};

//=============================================================================

}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
