udkapi/com/sun/star/uri/XVndSunStarPkgUrlReferenceFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_uri_XVndSunStarPkgUrlReferenceFactory_idl__
  21 #define __com_sun_star_uri_XVndSunStarPkgUrlReferenceFactory_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module uri {
  26
  27 published interface XUriReference;
  28
  29 /**
  30    creates &ldquo;vnd.sun.star.pkg&rdquo; URL references.
  31
  32    @since OOo 2.0
  33  */
  34 published interface XVndSunStarPkgUrlReferenceFactory {
  35     /**
  36        creates a new &ldquo;vnd.sun.star.pkg&rdquo; URL reference.
  37
  38        <p>The returned URL reference has the given authority, an empty path, and
  39        no fragment.</p>
  40
  41        @param authority the authority of the created URL reference; must not be
  42        `NULL`, and should be an absolute URI reference with no fragment
  43
  44        @return a new &ldquo;vnd.sun.star.pkg&rdquo; URL reference, or `NULL` if
  45        the given authority is either not an absolute URI reference or has a
  46        fragment
  47      */
  48     XUriReference createVndSunStarPkgUrlReference([in] XUriReference authority);
  49 };
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */