sd/source/ui/inc/framework/ResourceId.hxx

   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_SD_SOURCE_UI_INC_FRAMEWORK_RESOURCEID_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_FRAMEWORK_RESOURCEID_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <vector>
  26
  27 #include <com/sun/star/drawing/framework/XResourceId.hpp>
  28 #include <com/sun/star/lang/XInitialization.hpp>
  29 #include <com/sun/star/lang/XServiceInfo.hpp>
  30 #include <com/sun/star/util/XURLTransformer.hpp>
  31 #include <cppuhelper/implbase.hxx>
  32 #include <boost/scoped_ptr.hpp>
  33
  34 namespace {
  35
  36 typedef ::cppu::WeakImplHelper <
  37     css::drawing::framework::XResourceId,
  38     css::lang::XInitialization,
  39     css::lang::XServiceInfo
  40     > ResourceIdInterfaceBase;
  41
  42 } // end of anonymous namespace.
  43
  44 namespace sd { namespace framework {
  45
  46 /** Implementation of the css::drawing::framework::ResourceId
  47     service and the css::drawing::framework::XResourceId
  48     interface.
  49 */
  50 class ResourceId
  51     : public ResourceIdInterfaceBase
  52 {
  53 public:
  54     /** Create a new, empty resource id.
  55     */
  56     ResourceId();
  57
  58     /** Create a new resource id that is described by the given URLs.
  59         @param rsResourceURLs
  60             The first URL specifies the type of resource.  The other URLs
  61             describe its anchor.
  62             The set of URLs may be empty.  The result is then the same as
  63             returned by ResourceId() default constructor.
  64     */
  65     ResourceId (const ::std::vector<OUString>& rsResourceURLs);
  66
  67     /** Create a new resource id that has an empty anchor.
  68         @param rsResourceURL
  69             When this resource URL is empty then the resulting ResourceId
  70             object is identical to when the ResourceId() default constructor
  71             had been called.
  72     */
  73     ResourceId (
  74         const OUString& rsResourceURL);
  75
  76     /** Create a new resource id for the given resource type and an anchor
  77         that is specified by a single URL.  This constructor can be used for
  78         example for views that are bound to panes.
  79         @param rsResourceURL
  80             The URL of the actual resource.
  81         @param rsAnchorURL
  82             The single URL of the anchor.
  83     */
  84     ResourceId (
  85         const OUString& rsResourceURL,
  86         const OUString& rsAnchorURL);
  87
  88     /** Create a new resource id with an anchor that consists of a sequence
  89         of URLs that is extended by a further URL.
  90         @param rsResourceURL
  91             The URL of the actual resource.
  92         @param rsFirstAnchorURL
  93             This URL extends the anchor given by rAnchorURLs.
  94         @param rAnchorURLs
  95             An anchor as it is returned by XResourceId::getAnchorURLs().
  96     */
  97     ResourceId (
  98         const OUString& rsResourceURL,
  99         const OUString& rsFirstAnchorURL,
 100         const css::uno::Sequence<OUString>& rAnchorURLs);
 101
 102     virtual ~ResourceId();
 103
 104     /** Return the list of URLs of both the resource URL and the anchor
 105         URLs.
 106     */
 107     const ::std::vector<OUString>& GetResourceURLs() const;
 108
 109     //===== XResourceId =======================================================
 110
 111     virtual OUString SAL_CALL
 112         getResourceURL()
 113         throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 114
 115     virtual css::util::URL SAL_CALL
 116         getFullResourceURL()
 117         throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 118
 119     virtual sal_Bool SAL_CALL
 120         hasAnchor()
 121         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 122
 123     virtual css::uno::Reference<
 124         css::drawing::framework::XResourceId> SAL_CALL
 125         getAnchor()
 126         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 127
 128     virtual css::uno::Sequence<OUString> SAL_CALL
 129         getAnchorURLs()
 130         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 131
 132     virtual OUString SAL_CALL
 133         getResourceTypePrefix()
 134         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 135
 136     virtual sal_Int16 SAL_CALL
 137         compareTo (const css::uno::Reference<
 138             css::drawing::framework::XResourceId>& rxResourceId)
 139         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 140
 141     virtual sal_Bool SAL_CALL
 142         isBoundTo (
 143             const css::uno::Reference<
 144                 css::drawing::framework::XResourceId>& rxResourceId,
 145             css::drawing::framework::AnchorBindingMode eMode)
 146         throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 147
 148     virtual sal_Bool SAL_CALL
 149         isBoundToURL (
 150             const OUString& rsAnchorURL,
 151             css::drawing::framework::AnchorBindingMode eMode)
 152         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 153
 154     virtual css::uno::Reference<
 155         css::drawing::framework::XResourceId> SAL_CALL
 156         clone()
 157         throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 158
 159     //===== XInitialization ===================================================
 160
 161     void SAL_CALL initialize (
 162         const css::uno::Sequence<css::uno::Any>& aArguments)
 163         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 164
 165     OUString SAL_CALL getImplementationName()
 166         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 167
 168     sal_Bool SAL_CALL supportsService(OUString const & ServiceName)
 169         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 170
 171     css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames()
 172         throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 173
 174 private:
 175     /** The set of URLs that consist of the resource URL at index 0 and the
 176         anchor URLs and indices 1 and above.
 177     */
 178     ::std::vector<OUString> maResourceURLs;
 179
 180     ::boost::scoped_ptr<css::util::URL> mpURL;
 181
 182     static css::uno::WeakReference<css::util::XURLTransformer> mxURLTransformerWeak;
 183
 184     /** Compare the called ResourceId object to the given ResourceId object.
 185         This uses the implementation of both objects to speed up the
 186         comparison.
 187     */
 188     sal_Int16 CompareToLocalImplementation (const ResourceId& rId) const;
 189
 190     /** Compare the called ResourceId object to the given XResourceId object
 191         reference.  The comparison is done via the UNO interface.  Namely,
 192         it uses the getResourceURL() and the getAnchorURLs() methods to get
 193         access to the URLs of the given objec.
 194     */
 195     sal_Int16 CompareToExternalImplementation (const css::uno::Reference<
 196         css::drawing::framework::XResourceId>& rxId) const;
 197
 198     /** Return whether the called ResourceId object is bound to the anchor
 199         consisting of the URLs given by psFirstAnchorURL and paAnchorURLs.
 200         @param psFirstAnchorURL
 201             Optional first URL of the anchor. This can be missing or present
 202             independently of paAnchorURLs.
 203         @param paAnchorURLs
 204             Optional set of additional anchor URLs.  This can be missing or
 205             present independently of psFirstAnchorURL.
 206         @param eMode
 207             This specifies whether the called resource has to be directly
 208             bound to the given anchor in order to return <TRUE/> or whether
 209             it can be bound indirectly, too.
 210     */
 211     bool IsBoundToAnchor (
 212         const OUString* psFirstAnchorURL,
 213         const css::uno::Sequence<OUString>* paAnchorURLs,
 214         css::drawing::framework::AnchorBindingMode eMode) const;
 215
 216     /** Return whether the called ResourceId object is bound to the anchor
 217         consisting of the URLs in rResourceURLs.
 218         @param rResourceURLs
 219             A possibly empty list of anchor URLs.
 220         @param eMode
 221             This specifies whether the called resource has to be directly
 222             bound to the given anchor in order to return <TRUE/> or whether
 223             it can be bound indirectly, too.
 224     */
 225     bool IsBoundToAnchor (
 226         const ::std::vector<OUString>& rResourceURLs,
 227         css::drawing::framework::AnchorBindingMode eMode) const;
 228
 229     void ParseResourceURL();
 230 };
 231
 232 } } // end of namespace sd::framework
 233
 234 #endif
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */