Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_SD_SOURCE_UI_SIDEBAR_MASTERPAGECONTAINERFILLER_HXX
      21             : #define INCLUDED_SD_SOURCE_UI_SIDEBAR_MASTERPAGECONTAINERFILLER_HXX
      22             : 
      23             : #include "MasterPageContainer.hxx"
      24             : #include "MasterPageDescriptor.hxx"
      25             : #include "tools/AsynchronousTask.hxx"
      26             : 
      27             : namespace sd {
      28             : class TemplateScanner;
      29             : class TemplateEntry;
      30             : }
      31             : 
      32             : namespace sd { namespace sidebar {
      33             : 
      34             : /** Fill a MasterPageContainer with information about the available master
      35             :     pages.  These are provided by one default page and from the existing
      36             :     Impress templates.  This is done asynchronously.
      37             : */
      38             : class MasterPageContainerFiller
      39             :     : public ::sd::tools::AsynchronousTask
      40             : {
      41             : public:
      42           0 :     class ContainerAdapter
      43             :     {
      44             :     public:
      45             :         virtual MasterPageContainer::Token PutMasterPage (
      46             :             const SharedMasterPageDescriptor& rpDescriptor) = 0;
      47             :         /** This method is called when all Impress templates have been added
      48             :             to the container via the PutMasterPage() method.
      49             :         */
      50             :         virtual void FillingDone() = 0;
      51             : 
      52             :     protected:
      53           0 :         ~ContainerAdapter() {}
      54             :     };
      55             : 
      56             :     MasterPageContainerFiller (ContainerAdapter& rContainerAdapter);
      57             :     virtual ~MasterPageContainerFiller();
      58             : 
      59             :     /** Run the next step of the task.  After HasNextStep() returns false
      60             :         this method should ignore further calls.
      61             :     */
      62             :     virtual void RunNextStep() SAL_OVERRIDE;
      63             : 
      64             :     /** Return <TRUE/> when there is at least one more step to execute.
      65             :         When the task has been executed completely then <FALSE/> is
      66             :         returned.
      67             :     */
      68             :     virtual bool HasNextStep() SAL_OVERRIDE;
      69             : 
      70             : private:
      71             :     ContainerAdapter& mrContainerAdapter;
      72             :     // Remember what the next step has to do.
      73             :     enum State {
      74             :         INITIALIZE_TEMPLATE_SCANNER,
      75             :         SCAN_TEMPLATE,
      76             :         ADD_TEMPLATE,
      77             :         ERROR,
      78             :         DONE
      79             :     } meState;
      80             :     ::std::unique_ptr<TemplateScanner> mpScannerTask;
      81             :     const TemplateEntry* mpLastAddedEntry;
      82             :     int mnIndex;
      83             : 
      84             :     State ScanTemplate();
      85             :     State AddTemplate();
      86             : };
      87             : 
      88             : } } // end of namespace sd::sidebar
      89             : 
      90             : #endif
      91             : 
      92             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */