office-gobmx/udkapi/com/sun/star/uri/XUriSchemeParser.idl
2012-01-05 09:18:17 +00:00

78 lines
2.8 KiB
Text

/* -*- 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_uri_XUriSchemeParser_idl__
#define __com_sun_star_uri_XUriSchemeParser_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/uri/XUriReference.idl>
module com { module sun { module star { module uri {
/**
parses textual representations of absolute URIs.
<p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a> for a
description of URIs and related terms.</p>
@since OOo 2.0
*/
published interface XUriSchemeParser: com::sun::star::uno::XInterface {
/**
parses the textual representation of an absolute URI.
<p>This method is used to parse URIs (with no fragment part), not URI
references (with an optional fragment part).</p>
<p>If an object is returned, the behaviour of its
<type scope="com::sun::star::uri">XUriReference</type> methods must
reflect the fact that the object represents an absolute URI reference
with the given scheme and scheme-specific part, and without a fragment
part.</p>
@param scheme
the textual representation of the scheme part (without the delimiting
&ldquo;<code>:</code>&rdquo;).
@param uriReference
the textual representation of the scheme-specific part.
@returns
an object that supports
<type scope="com::sun::star::uri">XUriReference</type> (and possibly also
additional, scheme-specific interfaces), if the given input can be parsed
into an absolute URI; otherwise, <NULL/> is returned.
*/
XUriReference parse([in] string scheme, [in] string schemeSpecificPart);
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */