sd/source/ui/toolpanel/controls/MasterPageContainerQueue.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MasterPageContainerQueue.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_TOOLPANEL_CONTROLS_MASTER_PAGE_CONTAINER_QUEUE_HXX
  32 #define SD_TOOLPANEL_CONTROLS_MASTER_PAGE_CONTAINER_QUEUE_HXX
  33
  34 #include "MasterPageContainer.hxx"
  35 #include "MasterPageDescriptor.hxx"
  36
  37 #include <boost/scoped_ptr.hpp>
  38 #include <boost/weak_ptr.hpp>
  39
  40 namespace sd { namespace toolpanel { namespace controls {
  41
  42
  43 /** The queue stores and processes all requests from a MasterPageContainer
  44     for the creation of previews.
  45     The order of request processing and its timing is controlled by a
  46     heuristic that uses values given with each request and which is
  47     controlled by various parameters that are described below.
  48 */
  49 class MasterPageContainerQueue
  50 {
  51 public:
  52     class ContainerAdapter { public:
  53         virtual bool UpdateDescriptor (
  54             const SharedMasterPageDescriptor& rpDescriptor,
  55             bool bForcePageObject,
  56             bool bForcePreview,
  57             bool bSendEvents) = 0;
  58     };
  59
  60     static MasterPageContainerQueue* Create (
  61         const ::boost::weak_ptr<ContainerAdapter>& rpContainer);
  62     virtual ~MasterPageContainerQueue (void);
  63
  64     /** This method is typically called for entries in the container for
  65         which GetPreviewState() returns OS_CREATABLE.  The creation of the
  66         preview is then scheduled to be executed asynchronously at a later
  67         point in time.  When the preview is available the change listeners
  68         will be notified.
  69     */
  70     bool RequestPreview (const SharedMasterPageDescriptor& rDescriptor);
  71
  72     /** Return <TRUE/> when there is a request currently in the queue for
  73         the given token.
  74     */
  75     bool HasRequest (MasterPageContainer::Token aToken) const;
  76
  77     /** Return <TRUE/> when there is at least one request in the queue.
  78     */
  79     bool IsEmpty (void) const;
  80
  81     /** After this call the queue does not wait anymore for requests with
  82         higher priority when only a small number of requests with lower
  83         priority are present.  This method should be called when all
  84         templates are inserted into the MasterPageContainer.
  85     */
  86     void ProcessAllRequests (void);
  87
  88 private:
  89     ::boost::weak_ptr<ContainerAdapter> mpWeakContainer;
  90     class PreviewCreationRequest;
  91     class RequestQueue;
  92     ::boost::scoped_ptr<RequestQueue> mpRequestQueue;
  93     Timer maDelayedPreviewCreationTimer;
  94     sal_uInt32 mnRequestsServedCount;
  95
  96     // There are a couple of values that define various aspects of the
  97     // heuristic that defines the order and timing in which requests for
  98     // preview creation are processed.
  99
 100     /** The time to wait (in milliseconds) between the creation of previews.
 101     */
 102     static const sal_Int32 snDelayedCreationTimeout;
 103
 104     /** The time to wait when the system is not idle.
 105     */
 106     static const sal_Int32 snDelayedCreationTimeoutWhenNotIdle;
 107
 108     /** Requests for previews of master pages in a document have their
 109         priority increased by this value.
 110     */
 111     static const sal_Int32 snMasterPagePriorityBoost;
 112
 113     /** When only requests which a priority lower than this threshold exist
 114         and not many requests have been made yet then wait with processing
 115         them until more requests are present.
 116     */
 117     static const sal_Int32 snWaitForMoreRequestsPriorityThreshold;
 118
 119     /** When only requests which a priority lower than a threshold exist
 120         and not more requests than this number have been made or already
 121         processed then wait with processing them until more requests are
 122         present.
 123     */
 124     static sal_uInt32 snWaitForMoreRequestsCount;
 125
 126     MasterPageContainerQueue (const ::boost::weak_ptr<ContainerAdapter>& rpContainer);
 127     void LateInit (void);
 128
 129     /** Calculate the priority that defines the order in which requests
 130         are processed.
 131     */
 132     sal_Int32 CalculatePriority (const SharedMasterPageDescriptor& rDescriptor) const;
 133
 134     DECL_LINK(DelayedPreviewCreation, Timer *);
 135 };
 136
 137 } } } // end of namespace ::sd::toolpanel::controls
 138
 139 #endif