sd/source/ui/toolpanel/controls/MasterPageContainerFiller.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: MasterPageContainerFiller.hxx,v $
  10  * $Revision: 1.3 $
  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_FILLER_HXX
  32 #define SD_TOOLPANEL_CONTROLS_MASTER_PAGE_CONTAINER_FILLER_HXX
  33
  34 #include "MasterPageContainer.hxx"
  35 #include "MasterPageDescriptor.hxx"
  36 #include "tools/AsynchronousTask.hxx"
  37
  38 namespace sd {
  39 class TemplateScanner;
  40 class TemplateEntry;
  41 }
  42
  43 namespace sd { namespace toolpanel { namespace controls {
  44
  45 /** Fill a MasterPageContainer with information about the available master
  46     pages.  These are provided by one default page and from the existing
  47     Impress templates.  This is done asynchronously.
  48 */
  49 class MasterPageContainerFiller
  50     : public ::sd::tools::AsynchronousTask
  51 {
  52 public:
  53     class ContainerAdapter
  54     {
  55     public:
  56         virtual MasterPageContainer::Token PutMasterPage (
  57             const SharedMasterPageDescriptor& rpDescriptor) = 0;
  58         /** This method is called when all Impress templates have been added
  59             to the container via the PutMasterPage() method.
  60         */
  61         virtual void FillingDone (void) = 0;
  62     };
  63
  64     MasterPageContainerFiller (ContainerAdapter& rContainerAdapter);
  65     virtual ~MasterPageContainerFiller (void);
  66
  67     /** Run the next step of the task.  After HasNextStep() returns false
  68         this method should ignore further calls.
  69     */
  70     virtual void RunNextStep (void);
  71
  72     /** Return <TRUE/> when there is at least one more step to execute.
  73         When the task has been executed completely then <FALSE/> is
  74         returned.
  75     */
  76     virtual bool HasNextStep (void);
  77
  78 private:
  79     ContainerAdapter& mrContainerAdapter;
  80     // Remember what the next step has to do.
  81     enum State {
  82         INITIALIZE_TEMPLATE_SCANNER,
  83         SCAN_TEMPLATE,
  84         ADD_TEMPLATE,
  85         ERROR,
  86         DONE
  87     } meState;
  88     ::std::auto_ptr<TemplateScanner> mpScannerTask;
  89     const TemplateEntry* mpLastAddedEntry;
  90     int mnIndex;
  91
  92     State ScanTemplate (void);
  93     State AddTemplate (void);
  94 };
  95
  96 } } } // end of namespace ::sd::toolpanel::controls
  97
  98 #endif