diff options
author | Bjoern Michaelsen <bjoern.michaelsen@canonical.com> | 2013-04-18 18:26:28 +0200 |
---|---|---|
committer | Bjoern Michaelsen <bjoern.michaelsen@canonical.com> | 2013-04-23 22:20:31 +0200 |
commit | b9337e22ce1dbf2eba0e8c8db294ae99f4111f91 (patch) | |
tree | 53ee1bd3dfd213815a21579151983cb997922b05 /include/ucbhelper/fileidentifierconverter.hxx | |
parent | move global headers script (diff) | |
download | core-b9337e22ce1dbf2eba0e8c8db294ae99f4111f91.tar.gz core-b9337e22ce1dbf2eba0e8c8db294ae99f4111f91.zip |
execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/
and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details
Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
Diffstat (limited to 'include/ucbhelper/fileidentifierconverter.hxx')
-rw-r--r-- | include/ucbhelper/fileidentifierconverter.hxx | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/include/ucbhelper/fileidentifierconverter.hxx b/include/ucbhelper/fileidentifierconverter.hxx new file mode 100644 index 000000000000..052a7413bf93 --- /dev/null +++ b/include/ucbhelper/fileidentifierconverter.hxx @@ -0,0 +1,114 @@ +/* -*- 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 _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_ +#define _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 // _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_ + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |