LibreOffice: cppuhelper/unourl.hxx Source File

LibreOffice LibreOffice 7.1 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
27namespace rtl
28{
29class OUString;
30}
31
32namespace cppu
33{
41 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrlDescriptor
42{
43public:
44 class Impl;
45
54 explicit UnoUrlDescriptor(rtl::OUString const& rDescriptor);
55
56 UnoUrlDescriptor(UnoUrlDescriptor const& rOther);
57
58 ~UnoUrlDescriptor();
59
60 UnoUrlDescriptor& operator=(UnoUrlDescriptor const& rOther);
61
69 rtl::OUString const& getDescriptor() const;
70
77 rtl::OUString const& getName() const;
78
87 bool hasParameter(rtl::OUString const& rKey) const;
88
98 rtl::OUString getParameter(rtl::OUString const& rKey) const;
99
100private:
101 Impl* m_pImpl;
102};
103
132 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrl
133{
134public:
143 explicit UnoUrl(rtl::OUString const& rUrl);
144
145 UnoUrl(UnoUrl const& rOther);
146
147 ~UnoUrl();
148
149 UnoUrl& operator=(UnoUrl const& rOther);
150
157 UnoUrlDescriptor const& getConnection() const;
158
165 UnoUrlDescriptor const& getProtocol() const;
166
173 rtl::OUString const& getObjectName() const;
174
175private:
176 class Impl;
177
178 Impl* m_pImpl;
179};
180}
181
182#endif // INCLUDED_RTL_UNOURL_HXX
183
184/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:558
cppuhelperdllapi.h
CPPUHELPER_DLLPUBLIC
#define CPPUHELPER_DLLPUBLIC
Definition: cppuhelperdllapi.h:28
cppu
Definition: Enterable.hxx:27
rtl
Definition: unotype.hxx:43
cppu::UnoUrlDescriptor
A descriptor as part of a UNO URL (connection descriptor or protocol descriptor).
Definition: unourl.hxx:42
cppu::UnoUrlDescriptor::getParameter
rtl::OUString getParameter(rtl::OUString const &rKey) const
Return the parameter value for a key.
cppu::UnoUrlDescriptor::UnoUrlDescriptor
UnoUrlDescriptor(rtl::OUString const &rDescriptor)
Construct a descriptor from a string representation.
cppu::UnoUrlDescriptor::getDescriptor
rtl::OUString const & getDescriptor() const
Return the string representation of the descriptor.
cppu::UnoUrlDescriptor::~UnoUrlDescriptor
~UnoUrlDescriptor()
cppu::UnoUrlDescriptor::hasParameter
bool hasParameter(rtl::OUString const &rKey) const
Test whether the parameters contain a key.
cppu::UnoUrlDescriptor::getName
rtl::OUString const & getName() const
Return the name component of the descriptor.
cppu::UnoUrlDescriptor::UnoUrlDescriptor
UnoUrlDescriptor(UnoUrlDescriptor const &rOther)
cppu::UnoUrlDescriptor::operator=
UnoUrlDescriptor & operator=(UnoUrlDescriptor const &rOther)
cppu::UnoUrl
Parse UNO URLs into their components.
Definition: unourl.hxx:133
cppu::UnoUrl::UnoUrl
UnoUrl(UnoUrl const &rOther)
cppu::UnoUrl::~UnoUrl
~UnoUrl()
cppu::UnoUrl::operator=
UnoUrl & operator=(UnoUrl const &rOther)
cppu::UnoUrl::getObjectName
rtl::OUString const & getObjectName() const
Return the object-name component of the URL.
cppu::UnoUrl::getConnection
UnoUrlDescriptor const & getConnection() const
Return the connection descriptor component of the URL.
cppu::UnoUrl::getProtocol
UnoUrlDescriptor const & getProtocol() const
Return the protocol descriptor component of the URL.
cppu::UnoUrl::UnoUrl
UnoUrl(rtl::OUString const &rUrl)
Construct a UNO URL from a string representation.
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:161