/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: ResourceId.hxx,v $ * $Revision: 1.4 $ * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef SD_FRAMEWORK_RESOURCE_ID_HXX #define SD_FRAMEWORK_RESOURCE_ID_HXX #include #include #include #include #include namespace css = ::com::sun::star; namespace { typedef ::cppu::WeakImplHelper2 < css::drawing::framework::XResourceId, css::lang::XInitialization > ResourceIdInterfaceBase; } // end of anonymous namespace. namespace sd { namespace framework { /** Implementation of the css::drawing::framework::ResourceId service and the css::drawing::framework::XResourceId interface. */ class ResourceId : public ResourceIdInterfaceBase { public: /** Create a new, empty resource id. */ ResourceId (void); /** Create a new resource id that is described by the given URLs. @param rsResourceURLs The first URL specifies the type of resource. The other URLs describe its anchor. The set of URLs may be empty. The result is then the same as returned by ResourceId() default constructor. */ ResourceId (const ::std::vector& rsResourceURLs); /** Create a new resource id that has an empty anchor. @param rsResourceURL When this resource URL is empty then the resulting ResourceId object is identical to when the ResourceId() default constructor had been called. */ ResourceId ( const ::rtl::OUString& rsResourceURL); /** Create a new resource id for the given resource type and an anchor that is specified by a single URL. This constructor can be used for example for views that are bound to panes. @param rsResourceURL The URL of the actual resource. @param rsAnchorURL The single URL of the anchor. */ ResourceId ( const ::rtl::OUString& rsResourceURL, const ::rtl::OUString& rsAnchorURL); /** Create a new resource id for the specified resource type and the given list of anchor URLs. @param rsResourceURL The URL of the actual resource. @param rsAnchorURLs The possibly empty list of anchor URLs. */ ResourceId ( const ::rtl::OUString& rsResourceURL, const ::std::vector& rAnchorURLs); /** Create a new resource id with an anchor that consists of a sequence of URLs that is extended by a further URL. @param rsResourceURL The URL of the actual resource. @param rsFirstAnchorURL This URL extends the anchor given by rAnchorURLs. @param rAnchorURLs An anchor as it is returned by XResourceId::getAnchorURLs(). */ ResourceId ( const ::rtl::OUString& rsResourceURL, const ::rtl::OUString& rsFirstAnchorURL, const css::uno::Sequence& rAnchorURLs); virtual ~ResourceId (void); /** Return the list of URLs of both the resource URL and the anchor URLs. */ const ::std::vector& GetResourceURLs (void) const; //===== XResourceId ======================================================= virtual ::rtl::OUString SAL_CALL getResourceURL (void) throw(css::uno::RuntimeException); virtual css::util::URL SAL_CALL getFullResourceURL (void) throw(css::uno::RuntimeException); virtual sal_Bool SAL_CALL hasAnchor (void) throw (css::uno::RuntimeException); virtual css::uno::Reference< css::drawing::framework::XResourceId> SAL_CALL getAnchor (void) throw (css::uno::RuntimeException); virtual css::uno::Sequence SAL_CALL getAnchorURLs (void) throw (css::uno::RuntimeException); virtual ::rtl::OUString SAL_CALL getResourceTypePrefix (void) throw (css::uno::RuntimeException); virtual sal_Int16 SAL_CALL compareTo (const css::uno::Reference< css::drawing::framework::XResourceId>& rxResourceId) throw (css::uno::RuntimeException); virtual sal_Bool SAL_CALL isBoundTo ( const css::uno::Reference< css::drawing::framework::XResourceId>& rxResourceId, css::drawing::framework::AnchorBindingMode eMode) throw(css::uno::RuntimeException); virtual sal_Bool SAL_CALL isBoundToURL ( const ::rtl::OUString& rsAnchorURL, css::drawing::framework::AnchorBindingMode eMode) throw (css::uno::RuntimeException); virtual css::uno::Reference< css::drawing::framework::XResourceId> SAL_CALL clone (void) throw(css::uno::RuntimeException); //===== XInitialization =================================================== void SAL_CALL initialize ( const css::uno::Sequence& aArguments) throw (css::uno::RuntimeException); private: /** The set of URLs that consist of the resource URL at index 0 and the anchor URLs and indices 1 and above. */ ::std::vector maResourceURLs; ::boost::scoped_ptr mpURL; static css::uno::WeakReference mxURLTransformerWeak; /** Compare the called ResourceId object to the given ResourceId object. This uses the implementation of both objects to speed up the comparison. */ sal_Int16 CompareToLocalImplementation (const ResourceId& rId) const; /** Compare the called ResourceId object to the given XResourceId object reference. The comparison is done via the UNO interface. Namely, it uses the getResourceURL() and the getAnchorURLs() methods to get access to the URLs of the given objec. */ sal_Int16 CompareToExternalImplementation (const css::uno::Reference< css::drawing::framework::XResourceId>& rxId) const; /** Return whether the called ResourceId object is bound to the anchor consisting of the URLs given by psFirstAnchorURL and paAnchorURLs. @param psFirstAnchorURL Optional first URL of the anchor. This can be missing or present independently of paAnchorURLs. @param paAnchorURLs Optional set of additional anchor URLs. This can be missing or present independently of psFirstAnchorURL. @param eMode This specifies whether the called resource has to be directly bound to the given anchor in order to return or whether it can be bound indirectly, too. */ bool IsBoundToAnchor ( const rtl::OUString* psFirstAnchorURL, const css::uno::Sequence* paAnchorURLs, css::drawing::framework::AnchorBindingMode eMode) const; /** Return whether the called ResourceId object is bound to the anchor consisting of the URLs in rResourceURLs. @param rResourceURLs A possibly empty list of anchor URLs. @param eMode This specifies whether the called resource has to be directly bound to the given anchor in order to return or whether it can be bound indirectly, too. */ bool IsBoundToAnchor ( const ::std::vector& rResourceURLs, css::drawing::framework::AnchorBindingMode eMode) const; bool IsValid (void) const; void ParseResourceURL (void); }; } } // end of namespace sd::framework #endif