LibreOffice: cppuhelper/unourl.hxx Source File

LibreOffice LibreOffice 26.8 SDK C/C++ API Reference

Loading...
Searching...
No Matches
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/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_CPPUHELPER_UNOURL_HXX
25#define INCLUDED_CPPUHELPER_UNOURL_HXX
26
27#include "sal/config.h"
28
29#include "cppuhelper/cppuhelperdllapi.h"
30
31namespace rtl
32{
33class OUString;
34}
35
36namespace cppu
37{
45 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrlDescriptor
46{
47public:
48 class Impl;
49
58 explicit UnoUrlDescriptor(rtl::OUString const& rDescriptor);
59
60 UnoUrlDescriptor(UnoUrlDescriptor const& rOther);
61
62 ~UnoUrlDescriptor();
63
64 UnoUrlDescriptor& operator=(UnoUrlDescriptor const& rOther);
65
73 rtl::OUString const& getDescriptor() const;
74
81 rtl::OUString const& getName() const;
82
91 bool hasParameter(rtl::OUString const& rKey) const;
92
102 rtl::OUString getParameter(rtl::OUString const& rKey) const;
103
104private:
105 Impl* m_pImpl;
106};
107
136 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC UnoUrl
137{
138public:
147 explicit UnoUrl(rtl::OUString const& rUrl);
148
149 UnoUrl(UnoUrl const& rOther);
150
151 ~UnoUrl();
152
153 UnoUrl& operator=(UnoUrl const& rOther);
154
161 UnoUrlDescriptor const& getConnection() const;
162
169 UnoUrlDescriptor const& getProtocol() const;
170
177 rtl::OUString const& getObjectName() const;
178
179private:
180 class Impl;
181
182 Impl* m_pImpl;
183};
184}
185
186#endif // INCLUDED_RTL_UNOURL_HXX
187
188/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition types.h:611
config.h
cppuhelperdllapi.h
CPPUHELPER_DLLPUBLIC
#define CPPUHELPER_DLLPUBLIC
Definition cppuhelperdllapi.h:32
rtl
Definition bootstrap.hxx:34
cppu
Definition Enterable.hxx:31
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition ustring.hxx:168
cppu::UnoUrlDescriptor
A descriptor as part of a UNO URL (connection descriptor or protocol descriptor).
Definition unourl.hxx:46
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::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.