1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski #ifndef SD_SIDEBAR_PANELS_MASTER_PAGE_CONTAINER_HXX 23*b1cdbd2cSJim Jagielski #define SD_SIDEBAR_PANELS_MASTER_PAGE_CONTAINER_HXX 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski #include "MasterPageContainerProviders.hxx" 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <osl/mutex.hxx> 28*b1cdbd2cSJim Jagielski #include <tools/string.hxx> 29*b1cdbd2cSJim Jagielski #include <vcl/image.hxx> 30*b1cdbd2cSJim Jagielski #include <memory> 31*b1cdbd2cSJim Jagielski #include "PreviewRenderer.hxx" 32*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XModel.hpp> 33*b1cdbd2cSJim Jagielski #include <vcl/timer.hxx> 34*b1cdbd2cSJim Jagielski #include "tools/SdGlobalResourceContainer.hxx" 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski class SdPage; 39*b1cdbd2cSJim Jagielski class SdDrawDocument; 40*b1cdbd2cSJim Jagielski class SfxObjectShellLock; 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski namespace sd { 43*b1cdbd2cSJim Jagielski class DrawDocShell; 44*b1cdbd2cSJim Jagielski } 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski namespace sd { namespace sidebar { 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski class MasterPageDescriptor; 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski /** This container manages the master pages used by the MasterPagesSelector 51*b1cdbd2cSJim Jagielski controls. It uses internally a singleton implementation object. 52*b1cdbd2cSJim Jagielski Therefore, all MasterPageContainer object operator on the same set of 53*b1cdbd2cSJim Jagielski master pages. Each MasterPageContainer, however, has its own 54*b1cdbd2cSJim Jagielski PreviewSize value and thus can independantly switch between large and 55*b1cdbd2cSJim Jagielski small previews. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski The container maintains its own document to store master page objects. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski For each master page container stores its URL, preview bitmap, page 60*b1cdbd2cSJim Jagielski name, and, if available, the page object. 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski Entries are accessed via a Token, which is mostly a numerical index but 63*b1cdbd2cSJim Jagielski whose values do not neccessarily have to be consecutive. 64*b1cdbd2cSJim Jagielski */ 65*b1cdbd2cSJim Jagielski class MasterPageContainer 66*b1cdbd2cSJim Jagielski { 67*b1cdbd2cSJim Jagielski public: 68*b1cdbd2cSJim Jagielski typedef int Token; 69*b1cdbd2cSJim Jagielski static const Token NIL_TOKEN = -1; 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski MasterPageContainer (void); 72*b1cdbd2cSJim Jagielski virtual ~MasterPageContainer (void); 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski void AddChangeListener (const Link& rLink); 75*b1cdbd2cSJim Jagielski void RemoveChangeListener (const Link& rLink); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski enum PreviewSize { SMALL, LARGE }; 78*b1cdbd2cSJim Jagielski /** There are two different preview sizes, a small one and a large one. 79*b1cdbd2cSJim Jagielski Which one is used by the called container can be changed with this 80*b1cdbd2cSJim Jagielski method. 81*b1cdbd2cSJim Jagielski When the preview size is changed then all change listeners are 82*b1cdbd2cSJim Jagielski notified of this. 83*b1cdbd2cSJim Jagielski */ 84*b1cdbd2cSJim Jagielski void SetPreviewSize (PreviewSize eSize); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski /** Returns the preview size. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski PreviewSize GetPreviewSize (void) const; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** Return the preview size in pixels. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski Size GetPreviewSizePixel (void) const; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski enum PreviewState { PS_AVAILABLE, PS_CREATABLE, PS_PREPARING, PS_NOT_AVAILABLE }; 95*b1cdbd2cSJim Jagielski PreviewState GetPreviewState (Token aToken); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski /** This method is typically called for entries in the container for 98*b1cdbd2cSJim Jagielski which GetPreviewState() returns OS_CREATABLE. The creation of the 99*b1cdbd2cSJim Jagielski preview is then scheduled to be executed asynchronously at a later 100*b1cdbd2cSJim Jagielski point in time. When the preview is available the change listeners 101*b1cdbd2cSJim Jagielski will be notified. 102*b1cdbd2cSJim Jagielski */ 103*b1cdbd2cSJim Jagielski bool RequestPreview (Token aToken); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski /** Each entry of the container is either the first page of a template 106*b1cdbd2cSJim Jagielski document or is a master page of an Impress document. 107*b1cdbd2cSJim Jagielski */ 108*b1cdbd2cSJim Jagielski enum Origin { 109*b1cdbd2cSJim Jagielski MASTERPAGE, // Master page of a document. 110*b1cdbd2cSJim Jagielski TEMPLATE, // First page of a template file. 111*b1cdbd2cSJim Jagielski DEFAULT, // Empty master page with default style. 112*b1cdbd2cSJim Jagielski UNKNOWN 113*b1cdbd2cSJim Jagielski }; 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski /** Put the master page identified and described by the given parameters 116*b1cdbd2cSJim Jagielski into the container. When there already is a master page with the 117*b1cdbd2cSJim Jagielski given URL, page name, or object pointer (when that is not NULL) then 118*b1cdbd2cSJim Jagielski the existing entry is replaced/updated by the given one. Otherwise 119*b1cdbd2cSJim Jagielski a new entry is inserted. 120*b1cdbd2cSJim Jagielski */ 121*b1cdbd2cSJim Jagielski Token PutMasterPage (const ::boost::shared_ptr<MasterPageDescriptor>& rDescriptor); 122*b1cdbd2cSJim Jagielski void AcquireToken (Token aToken); 123*b1cdbd2cSJim Jagielski void ReleaseToken (Token aToken); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** This and the GetTokenForIndex() methods can be used to iterate over 126*b1cdbd2cSJim Jagielski all members of the container. 127*b1cdbd2cSJim Jagielski */ 128*b1cdbd2cSJim Jagielski int GetTokenCount (void) const; 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski /** Determine whether the container has a member for the given token. 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielski bool HasToken (Token aToken) const; 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski /** Return a token for an index in the range 135*b1cdbd2cSJim Jagielski 0 <= index < GetTokenCount(). 136*b1cdbd2cSJim Jagielski */ 137*b1cdbd2cSJim Jagielski Token GetTokenForIndex (int nIndex); 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski Token GetTokenForURL (const String& sURL); 140*b1cdbd2cSJim Jagielski Token GetTokenForStyleName (const String& sStyleName); 141*b1cdbd2cSJim Jagielski Token GetTokenForPageObject (const SdPage* pPage); 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski String GetURLForToken (Token aToken); 144*b1cdbd2cSJim Jagielski String GetPageNameForToken (Token aToken); 145*b1cdbd2cSJim Jagielski String GetStyleNameForToken (Token aToken); 146*b1cdbd2cSJim Jagielski SdPage* GetPageObjectForToken (Token aToken, bool bLoad=true); 147*b1cdbd2cSJim Jagielski Origin GetOriginForToken (Token aToken); 148*b1cdbd2cSJim Jagielski sal_Int32 GetTemplateIndexForToken (Token aToken); 149*b1cdbd2cSJim Jagielski ::boost::shared_ptr<MasterPageDescriptor> GetDescriptorForToken (Token aToken); 150*b1cdbd2cSJim Jagielski 151*b1cdbd2cSJim Jagielski void InvalidatePreview (Token aToken); 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski /** Return a preview for the specified token. When the preview is not 154*b1cdbd2cSJim Jagielski present then the PreviewProvider associated with the token is 155*b1cdbd2cSJim Jagielski executed only when that is not expensive. It is the responsibility 156*b1cdbd2cSJim Jagielski of the caller to call RequestPreview() to do the same 157*b1cdbd2cSJim Jagielski (asynchronously) for expensive PreviewProviders. 158*b1cdbd2cSJim Jagielski Call GetPreviewState() to find out if that is necessary. 159*b1cdbd2cSJim Jagielski @param aToken 160*b1cdbd2cSJim Jagielski This token specifies for which master page to return the prview. 161*b1cdbd2cSJim Jagielski Tokens are returned for example by the GetTokenFor...() methods. 162*b1cdbd2cSJim Jagielski @return 163*b1cdbd2cSJim Jagielski The returned image is the requested preview or a substitution. 164*b1cdbd2cSJim Jagielski */ 165*b1cdbd2cSJim Jagielski Image GetPreviewForToken (Token aToken); 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski private: 168*b1cdbd2cSJim Jagielski class Implementation; 169*b1cdbd2cSJim Jagielski ::boost::shared_ptr<Implementation> mpImpl; 170*b1cdbd2cSJim Jagielski PreviewSize mePreviewSize; 171*b1cdbd2cSJim Jagielski 172*b1cdbd2cSJim Jagielski /** Retrieve the preview of the document specified by the given URL. 173*b1cdbd2cSJim Jagielski */ 174*b1cdbd2cSJim Jagielski static BitmapEx LoadPreviewFromURL (const ::rtl::OUString& aURL); 175*b1cdbd2cSJim Jagielski }; 176*b1cdbd2cSJim Jagielski 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /** For some changes to the set of master pages in a MasterPageContainer or 181*b1cdbd2cSJim Jagielski to the data stored for each master page one or more events are sent to 182*b1cdbd2cSJim Jagielski registered listeners. 183*b1cdbd2cSJim Jagielski Each event has an event type and a token that tells the listener where 184*b1cdbd2cSJim Jagielski the change took place. 185*b1cdbd2cSJim Jagielski */ 186*b1cdbd2cSJim Jagielski class MasterPageContainerChangeEvent 187*b1cdbd2cSJim Jagielski { 188*b1cdbd2cSJim Jagielski public: 189*b1cdbd2cSJim Jagielski enum EventType { 190*b1cdbd2cSJim Jagielski // A master page was added to the container. 191*b1cdbd2cSJim Jagielski CHILD_ADDED, 192*b1cdbd2cSJim Jagielski // A master page was removed from the container. 193*b1cdbd2cSJim Jagielski CHILD_REMOVED, 194*b1cdbd2cSJim Jagielski // The preview of a master page has changed. 195*b1cdbd2cSJim Jagielski PREVIEW_CHANGED, 196*b1cdbd2cSJim Jagielski // The size of a preview has changed. 197*b1cdbd2cSJim Jagielski SIZE_CHANGED, 198*b1cdbd2cSJim Jagielski // Some of the data stored for a master page has changed. 199*b1cdbd2cSJim Jagielski DATA_CHANGED, 200*b1cdbd2cSJim Jagielski // The TemplateIndex of a master page has changed. 201*b1cdbd2cSJim Jagielski INDEX_CHANGED, 202*b1cdbd2cSJim Jagielski // More than one entries changed their TemplateIndex 203*b1cdbd2cSJim Jagielski INDEXES_CHANGED 204*b1cdbd2cSJim Jagielski } meEventType; 205*b1cdbd2cSJim Jagielski 206*b1cdbd2cSJim Jagielski // Token of the container entry whose data changed or which was added or 207*b1cdbd2cSJim Jagielski // removed. 208*b1cdbd2cSJim Jagielski MasterPageContainer::Token maChildToken; 209*b1cdbd2cSJim Jagielski }; 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski 212*b1cdbd2cSJim Jagielski } } // end of namespace sd::sidebar 213*b1cdbd2cSJim Jagielski 214*b1cdbd2cSJim Jagielski #endif 215