offapi/com/sun/star/xml/sax/XLocator.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: XLocator.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_xml_sax_XLocator_idl__
  31 #define __com_sun_star_xml_sax_XLocator_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module xml {  module sax {
  41
  42 //============================================================================
  43
  44 /** makes it possible to associate a SAX event with a document location.
  45
  46     <p>This interface is an IDL version of the Java interface
  47     <em>org.xml.sax.Locator</em>.</p>
  48  */
  49 published interface XLocator: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52     /** @returns
  53                     the column number where the current document event ends.
  54      */
  55     long getColumnNumber();
  56
  57     //-------------------------------------------------------------------------
  58     /** @returns
  59                     the line number where the current document event ends.
  60      */
  61     long getLineNumber();
  62
  63     //-------------------------------------------------------------------------
  64     /** @returns
  65                     the public identifier for the current document event.
  66      */
  67     string getPublicId();
  68
  69     //-------------------------------------------------------------------------
  70     /** @returns
  71                     the system identifier for the current document event.
  72      */
  73     string getSystemId();
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; }; };
  79
  80 #endif