LibreOffice: cppuhelper/unourl.hxx Source File

LibreOffice LibreOffice 5.4 SDK C/C++ API Reference

unourl.hxx
Go to the documentation of this file.
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 INCLUDED_CPPUHELPER_UNOURL_HXX
21 #define INCLUDED_CPPUHELPER_UNOURL_HXX
22
23 #include <sal/config.h>
24
25 #include <cppuhelper/cppuhelperdllapi.h>
26
27 namespace rtl { class OUString; }
28
29 namespace cppu {
30
38 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrlDescriptor
39 {
40 public:
41 class Impl;
42
51 explicit UnoUrlDescriptor(rtl::OUString const & rDescriptor);
52
53 UnoUrlDescriptor(UnoUrlDescriptor const & rOther);
54
55 ~UnoUrlDescriptor();
56
57 UnoUrlDescriptor & operator =(UnoUrlDescriptor const & rOther);
58
66 rtl::OUString const & getDescriptor() const;
67
74 rtl::OUString const & getName() const;
75
84 bool hasParameter(rtl::OUString const & rKey) const;
85
95 rtl::OUString getParameter(rtl::OUString const & rKey) const;
96
97 private:
98 Impl * m_pImpl;
99 };
100
129 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrl
130 {
131 public:
140 explicit UnoUrl(rtl::OUString const & rUrl);
141
142 UnoUrl(UnoUrl const & rOther);
143
144 ~UnoUrl();
145
146 UnoUrl & operator =(UnoUrl const & rOther);
147
154 UnoUrlDescriptor const & getConnection() const;
155
162 UnoUrlDescriptor const & getProtocol() const;
163
170 rtl::OUString const & getObjectName() const;
171
172 private:
173 class Impl;
174
175 Impl * m_pImpl;
176 };
177
178 }
179
180 #endif // INCLUDED_RTL_UNOURL_HXX
181
182 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
cppu::UnoUrlDescriptor
A descriptor as part of a UNO URL (connection descriptor or protocol descriptor). ...
Definition: unourl.hxx:38
CPPUHELPER_DLLPUBLIC
#define CPPUHELPER_DLLPUBLIC
Definition: cppuhelperdllapi.h:28
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:598
cppu
Definition: Enterable.hxx:26
config.h
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:120
cppuhelperdllapi.h
cppu::UnoUrl
Parse UNO URLs into their components.
Definition: unourl.hxx:129
rtl
Definition: bootstrap.hxx:29