1c45d927aSAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3c45d927aSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4c45d927aSAndrew Rist * or more contributor license agreements. See the NOTICE file 5c45d927aSAndrew Rist * distributed with this work for additional information 6c45d927aSAndrew Rist * regarding copyright ownership. The ASF licenses this file 7c45d927aSAndrew Rist * to you under the Apache License, Version 2.0 (the 8c45d927aSAndrew Rist * "License"); you may not use this file except in compliance 9c45d927aSAndrew Rist * with the License. You may obtain a copy of the License at 10c45d927aSAndrew Rist * 11c45d927aSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12c45d927aSAndrew Rist * 13c45d927aSAndrew Rist * Unless required by applicable law or agreed to in writing, 14c45d927aSAndrew Rist * software distributed under the License is distributed on an 15c45d927aSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16c45d927aSAndrew Rist * KIND, either express or implied. See the License for the 17c45d927aSAndrew Rist * specific language governing permissions and limitations 18c45d927aSAndrew Rist * under the License. 19c45d927aSAndrew Rist * 20c45d927aSAndrew Rist *************************************************************/ 21c45d927aSAndrew Rist 227a32b0c8SAndre Fischer #ifndef SD_SIDEBAR_PANELS_MASTER_PAGE_CONTAINER_PROVIDERS_HXX 237a32b0c8SAndre Fischer #define SD_SIDEBAR_PANELS_MASTER_PAGE_CONTAINER_PROVIDERS_HXX 24cdf0e10cSrcweir 25cdf0e10cSrcweir #include <rtl/ustring.hxx> 26cdf0e10cSrcweir #include <sfx2/objsh.hxx> 27cdf0e10cSrcweir 28cdf0e10cSrcweir class Image; 29cdf0e10cSrcweir class SdDrawDocument; 30cdf0e10cSrcweir class SdPage; 31cdf0e10cSrcweir namespace sd { class PreviewRenderer; } 32cdf0e10cSrcweir namespace sd { class DrawDocShell; } 33cdf0e10cSrcweir 34cdf0e10cSrcweir 357a32b0c8SAndre Fischer namespace sd { namespace sidebar { 36cdf0e10cSrcweir 37cdf0e10cSrcweir 38cdf0e10cSrcweir /** Interface for a provider of page objects. It is used by the 39cdf0e10cSrcweir MasterPageDescriptor to create master page objects on demand. 40cdf0e10cSrcweir */ 41cdf0e10cSrcweir class PageObjectProvider 42cdf0e10cSrcweir { 43cdf0e10cSrcweir public: 44cdf0e10cSrcweir /** Return a master page either by returning an already existing one, by 45cdf0e10cSrcweir creating a new page, or by loading a document. 46cdf0e10cSrcweir @param pDocument 47cdf0e10cSrcweir The document of the MasterPageContainer. It may be used to 48cdf0e10cSrcweir create new pages. 49cdf0e10cSrcweir */ 50cdf0e10cSrcweir virtual SdPage* operator() (SdDrawDocument* pDocument) = 0; 51cdf0e10cSrcweir 52cdf0e10cSrcweir /** An abstract value for the expected cost of providing a master page 53cdf0e10cSrcweir object. 54cdf0e10cSrcweir @return 55cdf0e10cSrcweir A value of 0 represents for the lowest cost, i.e. an almost 56cdf0e10cSrcweir immediate return. Positive values stand for higher costs. 57cdf0e10cSrcweir Negative values are not supported. 58cdf0e10cSrcweir */ 59cdf0e10cSrcweir virtual int GetCostIndex (void) = 0; 60cdf0e10cSrcweir 61cdf0e10cSrcweir virtual bool operator== (const PageObjectProvider& rProvider) = 0; 62cdf0e10cSrcweir }; 63cdf0e10cSrcweir 64cdf0e10cSrcweir 65cdf0e10cSrcweir 66cdf0e10cSrcweir 67cdf0e10cSrcweir class PreviewProvider 68cdf0e10cSrcweir { 69cdf0e10cSrcweir public: 70cdf0e10cSrcweir /** Create a preview image in the specified width. 71cdf0e10cSrcweir @param nWidth 72cdf0e10cSrcweir Requested width of the preview. The calling method can cope 73cdf0e10cSrcweir with other sizes as well but the resulting image quality is 74cdf0e10cSrcweir better when the returned image has the requested size. 75cdf0e10cSrcweir @param pPage 76cdf0e10cSrcweir Page object for which a preview is requested. This may be NULL 77cdf0e10cSrcweir when the page object is expensive to get and the PreviewProvider 78cdf0e10cSrcweir does not need this object (NeedsPageObject() returns false.) 79cdf0e10cSrcweir @param rRenderer 80cdf0e10cSrcweir This PreviewRenderer may be used by the PreviewProvider to 81cdf0e10cSrcweir create a preview image. 82cdf0e10cSrcweir */ 83cdf0e10cSrcweir virtual Image operator() (int nWidth, SdPage* pPage, ::sd::PreviewRenderer& rRenderer) = 0; 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** Return a value that indicates how expensive the creation of a 86cdf0e10cSrcweir preview image is. The higher the returned value the more expensive 87cdf0e10cSrcweir is the preview creation. Return 0 when the preview is already 88cdf0e10cSrcweir present and can be returned immediately. 89cdf0e10cSrcweir */ 90cdf0e10cSrcweir virtual int GetCostIndex (void) = 0; 91cdf0e10cSrcweir 92cdf0e10cSrcweir /** Return whether the page object passed is necessary to create a 93cdf0e10cSrcweir preview. 94cdf0e10cSrcweir */ 95cdf0e10cSrcweir virtual bool NeedsPageObject (void) = 0; 96cdf0e10cSrcweir }; 97cdf0e10cSrcweir 98cdf0e10cSrcweir 99cdf0e10cSrcweir 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** Provide previews of existing page objects by rendering them. 102cdf0e10cSrcweir */ 103cdf0e10cSrcweir class PagePreviewProvider : public PreviewProvider 104cdf0e10cSrcweir { 105cdf0e10cSrcweir public: 106cdf0e10cSrcweir PagePreviewProvider (void); 107cdf0e10cSrcweir virtual Image operator () (int nWidth, SdPage* pPage, ::sd::PreviewRenderer& rRenderer); 108cdf0e10cSrcweir virtual int GetCostIndex (void); 109cdf0e10cSrcweir virtual bool NeedsPageObject (void); 110cdf0e10cSrcweir private: 111cdf0e10cSrcweir }; 112cdf0e10cSrcweir 113cdf0e10cSrcweir 114cdf0e10cSrcweir 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** Provide master page objects for template documents for which only the 117cdf0e10cSrcweir URL is given. 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir class TemplatePageObjectProvider : public PageObjectProvider 120cdf0e10cSrcweir { 121cdf0e10cSrcweir public: 122cdf0e10cSrcweir TemplatePageObjectProvider (const ::rtl::OUString& rsURL); ~TemplatePageObjectProvider(void)123cdf0e10cSrcweir virtual ~TemplatePageObjectProvider (void) {}; 124cdf0e10cSrcweir virtual SdPage* operator () (SdDrawDocument* pDocument); 125cdf0e10cSrcweir virtual int GetCostIndex (void); 126cdf0e10cSrcweir virtual bool operator== (const PageObjectProvider& rProvider); 127cdf0e10cSrcweir private: 128cdf0e10cSrcweir ::rtl::OUString msURL; 129cdf0e10cSrcweir SfxObjectShellLock mxDocumentShell; 130cdf0e10cSrcweir ::sd::DrawDocShell* LoadDocument (const ::rtl::OUString& sFileName); 131cdf0e10cSrcweir }; 132cdf0e10cSrcweir 133cdf0e10cSrcweir 134cdf0e10cSrcweir 135cdf0e10cSrcweir 136cdf0e10cSrcweir /** Provide previews for template documents by loading the thumbnails from 137cdf0e10cSrcweir the documents. 138cdf0e10cSrcweir */ 139cdf0e10cSrcweir class TemplatePreviewProvider : public PreviewProvider 140cdf0e10cSrcweir { 141cdf0e10cSrcweir public: 142cdf0e10cSrcweir TemplatePreviewProvider (const ::rtl::OUString& rsURL); ~TemplatePreviewProvider(void)143cdf0e10cSrcweir virtual ~TemplatePreviewProvider (void) {}; 144cdf0e10cSrcweir virtual Image operator() (int nWidth, SdPage* pPage, ::sd::PreviewRenderer& rRenderer); 145cdf0e10cSrcweir virtual int GetCostIndex (void); 146cdf0e10cSrcweir virtual bool NeedsPageObject (void); 147cdf0e10cSrcweir private: 148cdf0e10cSrcweir ::rtl::OUString msURL; 149cdf0e10cSrcweir }; 150cdf0e10cSrcweir 151cdf0e10cSrcweir 152cdf0e10cSrcweir 153cdf0e10cSrcweir 154cdf0e10cSrcweir /** Create an empty default master page. 155cdf0e10cSrcweir */ 156cdf0e10cSrcweir class DefaultPageObjectProvider : public PageObjectProvider 157cdf0e10cSrcweir { 158cdf0e10cSrcweir public: 159cdf0e10cSrcweir DefaultPageObjectProvider (void); 160cdf0e10cSrcweir virtual SdPage* operator () (SdDrawDocument* pDocument); 161cdf0e10cSrcweir virtual int GetCostIndex (void); 162cdf0e10cSrcweir virtual bool operator== (const PageObjectProvider& rProvider); 163cdf0e10cSrcweir }; 164cdf0e10cSrcweir 165cdf0e10cSrcweir 166cdf0e10cSrcweir 167cdf0e10cSrcweir /** This implementation of the PageObjectProvider simply returns an already 168cdf0e10cSrcweir existing master page object. 169cdf0e10cSrcweir */ 1707a32b0c8SAndre Fischer class ExistingPageProvider : public PageObjectProvider 171cdf0e10cSrcweir { 172cdf0e10cSrcweir public: 173cdf0e10cSrcweir ExistingPageProvider (SdPage* pPage); 174cdf0e10cSrcweir virtual SdPage* operator() (SdDrawDocument* pDocument); 175cdf0e10cSrcweir virtual int GetCostIndex (void); 176cdf0e10cSrcweir virtual bool operator== (const PageObjectProvider& rProvider); 177cdf0e10cSrcweir private: 178cdf0e10cSrcweir SdPage* mpPage; 179cdf0e10cSrcweir }; 180cdf0e10cSrcweir 1817a32b0c8SAndre Fischer } } // end of namespace sd::sidebar 182cdf0e10cSrcweir 183cdf0e10cSrcweir #endif 184