239 lines
8 KiB
Text
239 lines
8 KiB
Text
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: XUriReference.idl,v $
|
|
*
|
|
* $Revision: 1.6 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-09 16:38:25 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library 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 for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __com_sun_star_uri_XUriReference_idl__
|
|
#define __com_sun_star_uri_XUriReference_idl__
|
|
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
|
|
module com { module sun { module star { module uri {
|
|
|
|
/**
|
|
represents generic, mutable URI references.
|
|
|
|
<p>See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a> for a
|
|
description of URI references and related terms.</p>
|
|
|
|
<p>This interface only handles generic URI references (both absolute and
|
|
relative). For specific URI schemes, there will be additional interfaces
|
|
that offer extra, scheme-specific functionality.</p>
|
|
|
|
@see com::sun::star::uri::UriReferenceFactory
|
|
which allows to create URI reference objects that support
|
|
<type scope="com::sun::star::uri">XUriReference</type> and additional,
|
|
scheme-specific interfaces.
|
|
|
|
@since OOo 2.0.0
|
|
*/
|
|
interface XUriReference: com::sun::star::uno::XInterface {
|
|
/**
|
|
returns the textual representation of the complete URI reference.
|
|
|
|
@returns
|
|
the textual representation of the complete URI reference. The exact
|
|
spelling of the URI reference is retained.
|
|
*/
|
|
string getUriReference();
|
|
|
|
/**
|
|
returns whether this URI reference is absolute or relative.
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference is absolute, <FALSE/> if it is relative.
|
|
*/
|
|
boolean isAbsolute();
|
|
|
|
/**
|
|
returns the scheme part of this (absolute) URI reference.
|
|
|
|
@returns
|
|
the textual representation of the scheme part (with the exact spelling
|
|
retained; without the delimiting “<code>:</code>”), if this
|
|
is an absolute URI reference; otherwise, an empty <atom>string</atom> is
|
|
returned.
|
|
*/
|
|
string getScheme();
|
|
|
|
/**
|
|
returns the scheme-specific part of this URI reference.
|
|
|
|
<p>For an absolute URI reference, the scheme-specific part is everything
|
|
after the scheme part and the delimiting “<code>:</code>”,
|
|
and before the optional “<code>#</code>” and fragment part.
|
|
For a relative URI reference, the scheme-specific part is everything
|
|
before the optional “<code>#</code>” and fragment part.</p>
|
|
|
|
@returns
|
|
the textual representation of the scheme-specific part (with the exact
|
|
spelling retained).
|
|
*/
|
|
string getSchemeSpecificPart();
|
|
|
|
/**
|
|
returns whether this URI reference is hierarchical or opaque.
|
|
|
|
<p>An absolute URI reference is hierarchical if its scheme-specific part
|
|
starts with “<code>/</code>”. A relative URI reference is
|
|
always hierarchical.</p>
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference is hierarchical, <FALSE/> if it is opaque.
|
|
*/
|
|
boolean isHierarchical();
|
|
|
|
/**
|
|
returns whether this (hierarchical) URI reference has an authority part.
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference is hierarchical and has an authority part.
|
|
*/
|
|
boolean hasAuthority();
|
|
|
|
/**
|
|
returns the authority part of this (hierarchical) URI reference.
|
|
|
|
@returns
|
|
the textual representation of the authority part (with the exact spelling
|
|
retained), if this is a hierarchical URI reference that has an authority
|
|
part; otherwise, an empty <atom>string</atom> is returned.
|
|
*/
|
|
string getAuthority();
|
|
|
|
/**
|
|
returns the path part of this URI reference.
|
|
|
|
@returns
|
|
the textual representation of the path part (with the exact spelling
|
|
retained), if this is a hierarchical URI reference; for an opaque URI
|
|
reference, the scheme-specific part (with the exact spelling retained) is
|
|
returned.
|
|
*/
|
|
string getPath();
|
|
|
|
/**
|
|
returns whether this (relative) URI reference has a relative path.
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference is relative and has a relative path.
|
|
*/
|
|
boolean hasRelativePath();
|
|
|
|
/**
|
|
returns the number of path segments of this (hierarchical) URI reference.
|
|
|
|
<p>For an opaque URI reference, and for a hierarchical URI reference with
|
|
an empty path, the number of path segments is zero. For a hierarchical
|
|
URI reference with an absolute, non-empty path, the number of path
|
|
segments equals the number of “<code>/</code>” delimiters.
|
|
For a hierarchical URI reference with a relative, non-empty path, the
|
|
number of path segments equals the number of “<code>/</code>”
|
|
delimiters, plus one.</p>
|
|
|
|
@returns
|
|
the number of path segments.
|
|
*/
|
|
long getPathSegmentCount();
|
|
|
|
/**
|
|
returns a given path segment of this (hierarchical) URI reference.
|
|
|
|
@param index
|
|
the index of the path segment, starting at zero.
|
|
|
|
@returns
|
|
the textual representation of the given path segment (with the exact
|
|
spelling retained, without any delimiting “<code>/</code>”),
|
|
if this URI reference is hierarchical and has that many path segments;
|
|
otherwise, and in particular if <code>index</code> is negative, an empty
|
|
<atom>string</atom> is returned.
|
|
*/
|
|
string getPathSegment([in] long index);
|
|
|
|
/**
|
|
returns whether this (hierarchical) URI reference has a query part.
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference is hierarchical and has a query part.
|
|
*/
|
|
boolean hasQuery();
|
|
|
|
/**
|
|
returns the query part of this (hierarchical) URI reference.
|
|
|
|
@returns
|
|
the textual representation of the query part (with the exact spelling
|
|
retained; without the delimiting “<code>?</code>”), if this
|
|
is a hierarchical URI reference that has a query part; otherwise, an
|
|
empty <atom>string</atom> is returned.
|
|
*/
|
|
string getQuery();
|
|
|
|
/**
|
|
returns whether this URI reference has a fragment part.
|
|
|
|
@returns
|
|
<TRUE/> if this URI reference has a fragment part.
|
|
*/
|
|
boolean hasFragment();
|
|
|
|
/**
|
|
returns the fragment part of this URI reference.
|
|
|
|
@returns
|
|
the textual representation of the fragment part (with the exact spelling
|
|
retained; without the delimiting “<code>#</code>”), if this
|
|
is a URI reference that has a fragment part; otherwise, an empty
|
|
<atom>string</atom> is returned.
|
|
*/
|
|
string getFragment();
|
|
|
|
/**
|
|
sets the fragment part of this URI reference.
|
|
|
|
@param fragment
|
|
the textual representation of the new fragment part. The exact spelling
|
|
will be preserved, and no escaping is performed.
|
|
*/
|
|
void setFragment([in] string fragment);
|
|
|
|
/**
|
|
clears the fragment part of this URI reference.
|
|
*/
|
|
void clearFragment();
|
|
};
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|