summaryrefslogtreecommitdiff
path: root/unotools/inc/unotools/ucbhelper.hxx
blob: 084db947853f7017e249ba106de77869f8a02817 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* -*- 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 _UNOTOOLS_UCBHELPER_HXX
#define _UNOTOOLS_UCBHELPER_HXX

#include "sal/config.h"

#include "com/sun/star/uno/Sequence.hxx"
#include "sal/types.h"
#include "unotools/unotoolsdllapi.h"

namespace com { namespace sun { namespace star { namespace uno {
    class Any;
} } } }
namespace rtl { class OUString; }
namespace ucbhelper { class Content; }

namespace utl { namespace UCBContentHelper {

UNOTOOLS_DLLPUBLIC bool IsDocument(rtl::OUString const & url);

UNOTOOLS_DLLPUBLIC bool IsFolder(rtl::OUString const & url);

/// @param title must not be null
/// @return true iff title has been set (i.e., if obtaining the "Title" property
///     of the given content yields a non-void value without raising a
///     non-RuntimeException; RuntimeExceptions are passed through)
UNOTOOLS_DLLPUBLIC bool GetTitle(
    rtl::OUString const & url, rtl::OUString * title);

UNOTOOLS_DLLPUBLIC bool Kill(rtl::OUString const & url);

UNOTOOLS_DLLPUBLIC com::sun::star::uno::Any GetProperty(
    rtl::OUString const & url, rtl::OUString const & property);

UNOTOOLS_DLLPUBLIC bool MakeFolder(
    ucbhelper::Content & parent, rtl::OUString const & title,
    ucbhelper::Content & result, bool exclusive = false);

/// @return the value of the "Size" property of the given content, or zero if
///     obtaining the property yields a void value or raises a
///     non-RuntimeException (RuntimeExceptions are passed through)
UNOTOOLS_DLLPUBLIC sal_Int64 GetSize(rtl::OUString const & url);

UNOTOOLS_DLLPUBLIC bool IsYounger(
    rtl::OUString const & younger, rtl::OUString const & older);

UNOTOOLS_DLLPUBLIC bool Exists(rtl::OUString const & url);

UNOTOOLS_DLLPUBLIC bool IsSubPath(
    rtl::OUString const & parent, rtl::OUString const & child);

UNOTOOLS_DLLPUBLIC bool EqualURLs(
    rtl::OUString const & url1, rtl::OUString const & url2);

} }

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */