xref: /AOO42X/main/offapi/com/sun/star/xml/sax/XLocator.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_xml_sax_XLocator_idl__
28#define __com_sun_star_xml_sax_XLocator_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module xml {  module sax {
38
39//============================================================================
40
41/** makes it possible to associate a SAX event with a document location.
42
43    <p>This interface is an IDL version of the Java interface
44    <em>org.xml.sax.Locator</em>.</p>
45 */
46published interface XLocator: com::sun::star::uno::XInterface
47{
48    //-------------------------------------------------------------------------
49    /** @returns
50                    the column number where the current document event ends.
51     */
52    long getColumnNumber();
53
54    //-------------------------------------------------------------------------
55    /** @returns
56                    the line number where the current document event ends.
57     */
58    long getLineNumber();
59
60    //-------------------------------------------------------------------------
61    /** @returns
62                    the public identifier for the current document event.
63     */
64    string getPublicId();
65
66    //-------------------------------------------------------------------------
67    /** @returns
68                    the system identifier for the current document event.
69     */
70    string getSystemId();
71};
72
73//=============================================================================
74
75}; }; }; }; };
76
77#endif
78