sd/source/ui/sidebar/MasterPageContainerFiller.hxx

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