114 lines
4.1 KiB
C++
114 lines
4.1 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_UCBHELPER_FILEIDENTIFIERCONVERTER_HXX
|
|
#define INCLUDED_UCBHELPER_FILEIDENTIFIERCONVERTER_HXX
|
|
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
#include <sal/types.h>
|
|
#include <ucbhelper/ucbhelperdllapi.h>
|
|
|
|
namespace com { namespace sun { namespace star { namespace ucb {
|
|
class XUniversalContentBroker;
|
|
} } } }
|
|
|
|
namespace ucbhelper {
|
|
|
|
//============================================================================
|
|
/** Get a 'root' URL for the most 'local' file content provider.
|
|
|
|
@descr
|
|
The result can be used as the rBaseURL parameter of
|
|
ucb::getFileURLFromSystemPath().
|
|
|
|
@returns
|
|
either a 'root' URL for the most 'local' file content provider, or an
|
|
empty string, if no such URL can meaningfully be constructed.
|
|
*/
|
|
UCBHELPER_DLLPUBLIC OUString getLocalFileURL()
|
|
SAL_THROW((com::sun::star::uno::RuntimeException));
|
|
|
|
//============================================================================
|
|
/** Using a specific content provider manager, convert a file path in system
|
|
dependent notation to a (file) URL.
|
|
|
|
@param rManager
|
|
A content provider manager. Must not be null.
|
|
|
|
@param rBaseURL
|
|
See the corresponding parameter of
|
|
com::sun::star::ucb::XFileIdentifierConverter::getFileURLFromSystemPath().
|
|
|
|
@param rURL
|
|
See the corresponding parameter of
|
|
com::sun::star::ucb::XFileIdentifierConverter::getFileURLFromSystemPath().
|
|
|
|
@returns
|
|
a URL, if the content provider registered at the content provider manager
|
|
that is responsible for the base URL returns a URL when calling
|
|
com::sun::star::ucb::XFileIdentiferConverter::getFileURLFromSystemPath()
|
|
on it. Otherwise, an empty string is returned.
|
|
|
|
@see
|
|
com::sun::star::ucb::XFileIdentiferConverter::getFileURLFromSystemPath().
|
|
*/
|
|
UCBHELPER_DLLPUBLIC OUString
|
|
getFileURLFromSystemPath(
|
|
com::sun::star::uno::Reference<
|
|
com::sun::star::ucb::XUniversalContentBroker > const &
|
|
rUcb,
|
|
OUString const & rBaseURL,
|
|
OUString const & rSystemPath)
|
|
SAL_THROW((com::sun::star::uno::RuntimeException));
|
|
|
|
//============================================================================
|
|
/** Using a specific content provider manager, convert a (file) URL to a
|
|
file path in system dependent notation.
|
|
|
|
@param rManager
|
|
A content provider manager. Must not be null.
|
|
|
|
@param rURL
|
|
See the corresponding parameter of
|
|
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL().
|
|
|
|
@returns
|
|
a system path, if the content provider registered at the content provider
|
|
manager that is responsible for the base URL returns a system path when
|
|
calling
|
|
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL()
|
|
on it. Otherwise, an empty string is returned.
|
|
|
|
@see
|
|
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL().
|
|
*/
|
|
UCBHELPER_DLLPUBLIC OUString
|
|
getSystemPathFromFileURL(
|
|
com::sun::star::uno::Reference<
|
|
com::sun::star::ucb::XUniversalContentBroker > const &
|
|
rUcb,
|
|
OUString const & rURL)
|
|
SAL_THROW((com::sun::star::uno::RuntimeException));
|
|
|
|
}
|
|
|
|
#endif // INCLUDED_UCBHELPER_FILEIDENTIFIERCONVERTER_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|